diff --git a/sdk/communication/azure-communication-jobrouter/_meta.json b/sdk/communication/azure-communication-jobrouter/_meta.json new file mode 100644 index 000000000000..99739609014d --- /dev/null +++ b/sdk/communication/azure-communication-jobrouter/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "70a4ccdd2be61ae5bc524250c70270b0f4f2b540", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/communication/Communication.JobRouter", + "@azure-tools/typespec-python": "0.21.0" +} \ No newline at end of file diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/__init__.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/__init__.py index ba2b07fc1b38..30a55b8c5a1c 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/__init__.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/__init__.py @@ -6,8 +6,8 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._patch import JobRouterAdministrationClient -from ._patch import JobRouterClient +from ._client import JobRouterAdministrationClient +from ._client import JobRouterClient from ._version import VERSION __version__ = VERSION diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_model_base.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_model_base.py index 19345476efdc..1ddc071517d6 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_model_base.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_model_base.py @@ -5,9 +5,9 @@ # license information. # -------------------------------------------------------------------------- # pylint: disable=protected-access, arguments-differ, signature-differs, broad-except -# pyright: reportGeneralTypeIssues=false import calendar +import decimal import functools import sys import logging @@ -15,9 +15,11 @@ import re import copy import typing -import email +import enum +import email.utils from datetime import datetime, date, time, timedelta, timezone from json import JSONEncoder +from typing_extensions import Self import isodate from azure.core.exceptions import DeserializationError from azure.core import CaseInsensitiveEnumMeta @@ -34,6 +36,7 @@ __all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") def _timedelta_as_isostr(td: timedelta) -> str: @@ -144,6 +147,8 @@ def default(self, o): # pylint: disable=too-many-return-statements except TypeError: if isinstance(o, _Null): return None + if isinstance(o, decimal.Decimal): + return float(o) if isinstance(o, (bytes, bytearray)): return _serialize_bytes(o, self.format) try: @@ -239,7 +244,7 @@ def _deserialize_date(attr: typing.Union[str, date]) -> date: # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. if isinstance(attr, date): return attr - return isodate.parse_date(attr, defaultmonth=None, defaultday=None) + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore def _deserialize_time(attr: typing.Union[str, time]) -> time: @@ -275,6 +280,12 @@ def _deserialize_duration(attr): return isodate.parse_duration(attr) +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + _DESERIALIZE_MAPPING = { datetime: _deserialize_datetime, date: _deserialize_date, @@ -283,6 +294,7 @@ def _deserialize_duration(attr): bytearray: _deserialize_bytes, timedelta: _deserialize_duration, typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, } _DESERIALIZE_MAPPING_WITHFORMAT = { @@ -365,8 +377,12 @@ def get(self, key: str, default: typing.Any = None) -> typing.Any: except KeyError: return default - @typing.overload # type: ignore - def pop(self, key: str) -> typing.Any: # pylint: disable=no-member + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... @typing.overload @@ -387,8 +403,8 @@ def clear(self) -> None: def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: self._data.update(*args, **kwargs) - @typing.overload # type: ignore - def setdefault(self, key: str) -> typing.Any: + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... @typing.overload @@ -426,6 +442,10 @@ def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-m return tuple(_serialize(x, format) for x in o) if isinstance(o, (bytes, bytearray)): return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value try: # First try datetime.datetime return _serialize_datetime(o, format) @@ -450,7 +470,13 @@ def _get_rest_field( def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: - return _deserialize(rf._type, value) if (rf and rf._is_model) else _serialize(value, rf._format if rf else None) + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) class Model(_MyMutableMapping): @@ -486,7 +512,7 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: def copy(self) -> "Model": return Model(self.__dict__) - def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> "Model": # pylint: disable=unused-argument + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property @@ -528,7 +554,7 @@ def _deserialize(cls, data, exist_discriminators): return cls(data) discriminator = cls._get_discriminator(exist_discriminators) exist_discriminators.append(discriminator) - mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pylint: disable=no-member + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member if mapped_cls == cls: return cls(data) return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access @@ -545,9 +571,16 @@ def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing. if exclude_readonly: readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] for k, v in self.items(): - if exclude_readonly and k in readonly_props: # pyright: ignore[reportUnboundVariable] + if exclude_readonly and k in readonly_props: # pyright: ignore continue - result[k] = Model._as_dict_value(v, exclude_readonly=exclude_readonly) + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) return result @staticmethod @@ -555,7 +588,7 @@ def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: if v is None or isinstance(v, _Null): return None if isinstance(v, (list, tuple, set)): - return [Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v] + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) if isinstance(v, dict): return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v @@ -593,29 +626,22 @@ def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj return obj return _deserialize(model_deserializer, obj) - return functools.partial(_deserialize_model, annotation) + return functools.partial(_deserialize_model, annotation) # pyright: ignore except Exception: pass # is it a literal? try: - if sys.version_info >= (3, 8): - from typing import ( - Literal, - ) # pylint: disable=no-name-in-module, ungrouped-imports - else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - - if annotation.__origin__ == Literal: + if annotation.__origin__ is typing.Literal: # pyright: ignore return None except AttributeError: pass # is it optional? try: - if any(a for a in annotation.__args__ if a == type(None)): + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore if_obj_deserializer = _get_deserialize_callable_from_annotation( - next(a for a in annotation.__args__ if a != type(None)), module, rf + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore ) def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): @@ -628,7 +654,13 @@ def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Calla pass if getattr(annotation, "__origin__", None) is typing.Union: - deserializers = [_get_deserialize_callable_from_annotation(arg, module, rf) for arg in annotation.__args__] + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] def _deserialize_with_union(deserializers, obj): for deserializer in deserializers: @@ -641,32 +673,28 @@ def _deserialize_with_union(deserializers, obj): return functools.partial(_deserialize_with_union, deserializers) try: - if annotation._name == "Dict": - key_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) - value_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[1], module, rf) + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) def _deserialize_dict( - key_deserializer: typing.Optional[typing.Callable], value_deserializer: typing.Optional[typing.Callable], obj: typing.Dict[typing.Any, typing.Any], ): if obj is None: return obj - return { - _deserialize(key_deserializer, k, module): _deserialize(value_deserializer, v, module) - for k, v in obj.items() - } + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} return functools.partial( _deserialize_dict, - key_deserializer, value_deserializer, ) except (AttributeError, IndexError): pass try: - if annotation._name in ["List", "Set", "Tuple", "Sequence"]: - if len(annotation.__args__) > 1: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore def _deserialize_multiple_sequence( entry_deserializers: typing.List[typing.Optional[typing.Callable]], @@ -680,10 +708,13 @@ def _deserialize_multiple_sequence( ) entry_deserializers = [ - _get_deserialize_callable_from_annotation(dt, module, rf) for dt in annotation.__args__ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore ] return functools.partial(_deserialize_multiple_sequence, entry_deserializers) - deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) def _deserialize_sequence( deserializer: typing.Optional[typing.Callable], @@ -698,19 +729,21 @@ def _deserialize_sequence( pass def _deserialize_default( - annotation, - deserializer_from_mapping, + deserializer, obj, ): if obj is None: return obj try: - return _deserialize_with_callable(annotation, obj) + return _deserialize_with_callable(deserializer, obj) except Exception: pass - return _deserialize_with_callable(deserializer_from_mapping, obj) + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) - return functools.partial(_deserialize_default, annotation, get_deserializer(annotation, rf)) + return functools.partial(_deserialize_default, annotation) def _deserialize_with_callable( @@ -718,7 +751,7 @@ def _deserialize_with_callable( value: typing.Any, ): try: - if value is None: + if value is None or isinstance(value, _Null): return None if deserializer is None: return value @@ -746,7 +779,8 @@ def _deserialize( value = value.http_response.json() if rf is None and format: rf = _RestField(format=format) - deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) return _deserialize_with_callable(deserializer, value) @@ -760,6 +794,7 @@ def __init__( visibility: typing.Optional[typing.List[str]] = None, default: typing.Any = _UNSET, format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, ): self._type = type self._rest_name_input = name @@ -769,6 +804,11 @@ def __init__( self._is_model = False self._default = default self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] @property def _rest_name(self) -> str: @@ -814,8 +854,16 @@ def rest_field( visibility: typing.Optional[typing.List[str]] = None, default: typing.Any = _UNSET, format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, ) -> typing.Any: - return _RestField(name=name, type=type, visibility=visibility, default=default, format=format) + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + ) def rest_discriminator( diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_operations/__init__.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_operations/__init__.py index 06eb1614ceb7..716a8d30dd24 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_operations/__init__.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_operations/__init__.py @@ -6,8 +6,8 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._patch import JobRouterAdministrationClientOperationsMixin -from ._patch import JobRouterClientOperationsMixin +from ._operations import JobRouterAdministrationClientOperationsMixin +from ._operations import JobRouterClientOperationsMixin from ._patch import __all__ as _patch_all from ._patch import * # pylint: disable=unused-wildcard-import diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_operations/_operations.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_operations/_operations.py index ffd66a0b45d9..f3ab89fc29ab 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_operations/_operations.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_operations/_operations.py @@ -1,4 +1,4 @@ -# pylint: disable=too-many-lines +# pylint: disable=too-many-lines,too-many-statements # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -10,7 +10,7 @@ from io import IOBase import json import sys -from typing import Any, Callable, Dict, IO, List, Optional, TypeVar, Union, overload +from typing import Any, Callable, Dict, IO, Iterable, List, Optional, TypeVar, Union, overload import urllib.parse from azure.core import MatchConditions @@ -1002,6 +1002,7 @@ def upsert_distribution_policy( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.DistributionPolicy: + # pylint: disable=line-too-long """Creates or updates a distribution policy. Creates or updates a distribution policy. @@ -1021,11 +1022,246 @@ def upsert_distribution_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DistributionPolicy. The DistributionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.DistributionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } """ @overload @@ -1040,6 +1276,7 @@ def upsert_distribution_policy( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.DistributionPolicy: + # pylint: disable=line-too-long """Creates or updates a distribution policy. Creates or updates a distribution policy. @@ -1059,18 +1296,171 @@ def upsert_distribution_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DistributionPolicy. The DistributionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.DistributionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } """ @overload def upsert_distribution_policy( self, distribution_policy_id: str, - resource: IO, + resource: IO[bytes], *, content_type: str = "application/merge-patch+json", if_unmodified_since: Optional[datetime.datetime] = None, @@ -1078,6 +1468,7 @@ def upsert_distribution_policy( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.DistributionPolicy: + # pylint: disable=line-too-long """Creates or updates a distribution policy. Creates or updates a distribution policy. @@ -1085,7 +1476,7 @@ def upsert_distribution_policy( :param distribution_policy_id: Id of a distribution policy. Required. :type distribution_policy_id: str :param resource: The resource instance. Required. - :type resource: IO + :type resource: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str @@ -1097,24 +1488,178 @@ def upsert_distribution_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DistributionPolicy. The DistributionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.DistributionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } """ @distributed_trace def upsert_distribution_policy( self, distribution_policy_id: str, - resource: Union[_models.DistributionPolicy, JSON, IO], + resource: Union[_models.DistributionPolicy, JSON, IO[bytes]], *, if_unmodified_since: Optional[datetime.datetime] = None, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.DistributionPolicy: + # pylint: disable=line-too-long """Creates or updates a distribution policy. Creates or updates a distribution policy. @@ -1122,8 +1667,8 @@ def upsert_distribution_policy( :param distribution_policy_id: Id of a distribution policy. Required. :type distribution_policy_id: str :param resource: The resource instance. Is one of the following types: DistributionPolicy, - JSON, IO Required. - :type resource: ~azure.communication.jobrouter.models.DistributionPolicy or JSON or IO + JSON, IO[bytes] Required. + :type resource: ~azure.communication.jobrouter.models.DistributionPolicy or JSON or IO[bytes] :keyword if_unmodified_since: The request should only proceed if the entity was not modified after this time. Default value is None. :paramtype if_unmodified_since: ~datetime.datetime @@ -1132,13 +1677,246 @@ def upsert_distribution_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DistributionPolicy. The DistributionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.DistributionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } """ error_map = { 401: ClientAuthenticationError, @@ -1222,17 +2000,100 @@ def upsert_distribution_policy( @distributed_trace def get_distribution_policy(self, distribution_policy_id: str, **kwargs: Any) -> _models.DistributionPolicy: + # pylint: disable=line-too-long """Retrieves an existing distribution policy by Id. Retrieves an existing distribution policy by Id. :param distribution_policy_id: Id of a distribution policy. Required. :type distribution_policy_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DistributionPolicy. The DistributionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.DistributionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } """ error_map = { 401: ClientAuthenticationError, @@ -1286,7 +2147,8 @@ def get_distribution_policy(self, distribution_policy_id: str, **kwargs: Any) -> return deserialized # type: ignore @distributed_trace - def list_distribution_policies(self, **kwargs: Any) -> ItemPaged["_models.DistributionPolicy"]: + def list_distribution_policies(self, **kwargs: Any) -> Iterable["_models.DistributionPolicy"]: + # pylint: disable=line-too-long """Retrieves existing distribution policies. Retrieves existing distribution policies. @@ -1294,6 +2156,90 @@ def list_distribution_policies(self, **kwargs: Any) -> ItemPaged["_models.Distri :return: An iterator like instance of DistributionPolicy :rtype: ~azure.core.paging.ItemPaged[~azure.communication.jobrouter.models.DistributionPolicy] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } """ _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} @@ -1439,6 +2385,7 @@ def upsert_classification_policy( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.ClassificationPolicy: + # pylint: disable=line-too-long """Creates or updates a classification policy. Creates or updates a classification policy. @@ -1458,11 +2405,195 @@ def upsert_classification_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ClassificationPolicy. The ClassificationPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ClassificationPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } """ @overload @@ -1477,6 +2608,7 @@ def upsert_classification_policy( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.ClassificationPolicy: + # pylint: disable=line-too-long """Creates or updates a classification policy. Creates or updates a classification policy. @@ -1496,18 +2628,135 @@ def upsert_classification_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ClassificationPolicy. The ClassificationPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ClassificationPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } """ @overload def upsert_classification_policy( self, classification_policy_id: str, - resource: IO, + resource: IO[bytes], *, content_type: str = "application/merge-patch+json", if_unmodified_since: Optional[datetime.datetime] = None, @@ -1515,6 +2764,7 @@ def upsert_classification_policy( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.ClassificationPolicy: + # pylint: disable=line-too-long """Creates or updates a classification policy. Creates or updates a classification policy. @@ -1522,7 +2772,7 @@ def upsert_classification_policy( :param classification_policy_id: Id of a classification policy. Required. :type classification_policy_id: str :param resource: The resource instance. Required. - :type resource: IO + :type resource: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str @@ -1534,48 +2784,348 @@ def upsert_classification_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ClassificationPolicy. The ClassificationPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ClassificationPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } """ @distributed_trace def upsert_classification_policy( self, classification_policy_id: str, - resource: Union[_models.ClassificationPolicy, JSON, IO], + resource: Union[_models.ClassificationPolicy, JSON, IO[bytes]], *, if_unmodified_since: Optional[datetime.datetime] = None, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.ClassificationPolicy: + # pylint: disable=line-too-long """Creates or updates a classification policy. Creates or updates a classification policy. - :param classification_policy_id: Id of a classification policy. Required. - :type classification_policy_id: str - :param resource: The resource instance. Is one of the following types: ClassificationPolicy, - JSON, IO Required. - :type resource: ~azure.communication.jobrouter.models.ClassificationPolicy or JSON or IO - :keyword if_unmodified_since: The request should only proceed if the entity was not modified - after this time. Default value is None. - :paramtype if_unmodified_since: ~datetime.datetime - :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is - None. - :paramtype etag: str - :keyword match_condition: The match condition to use upon the etag. Default value is None. - :paramtype match_condition: ~azure.core.MatchConditions - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: ClassificationPolicy. The ClassificationPolicy is compatible with MutableMapping - :rtype: ~azure.communication.jobrouter.models.ClassificationPolicy - :raises ~azure.core.exceptions.HttpResponseError: + :param classification_policy_id: Id of a classification policy. Required. + :type classification_policy_id: str + :param resource: The resource instance. Is one of the following types: ClassificationPolicy, + JSON, IO[bytes] Required. + :type resource: ~azure.communication.jobrouter.models.ClassificationPolicy or JSON or IO[bytes] + :keyword if_unmodified_since: The request should only proceed if the entity was not modified + after this time. Default value is None. + :paramtype if_unmodified_since: ~datetime.datetime + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ClassificationPolicy. The ClassificationPolicy is compatible with MutableMapping + :rtype: ~azure.communication.jobrouter.models.ClassificationPolicy + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } """ error_map = { 401: ClientAuthenticationError, @@ -1659,17 +3209,85 @@ def upsert_classification_policy( @distributed_trace def get_classification_policy(self, classification_policy_id: str, **kwargs: Any) -> _models.ClassificationPolicy: + # pylint: disable=line-too-long """Retrieves an existing classification policy by Id. Retrieves an existing classification policy by Id. :param classification_policy_id: Id of a classification policy. Required. :type classification_policy_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ClassificationPolicy. The ClassificationPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ClassificationPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } """ error_map = { 401: ClientAuthenticationError, @@ -1723,7 +3341,8 @@ def get_classification_policy(self, classification_policy_id: str, **kwargs: Any return deserialized # type: ignore @distributed_trace - def list_classification_policies(self, **kwargs: Any) -> ItemPaged["_models.ClassificationPolicy"]: + def list_classification_policies(self, **kwargs: Any) -> Iterable["_models.ClassificationPolicy"]: + # pylint: disable=line-too-long """Retrieves existing classification policies. Retrieves existing classification policies. @@ -1732,6 +3351,75 @@ def list_classification_policies(self, **kwargs: Any) -> ItemPaged["_models.Clas :rtype: ~azure.core.paging.ItemPaged[~azure.communication.jobrouter.models.ClassificationPolicy] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } """ _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} @@ -1896,11 +3584,44 @@ def upsert_exception_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ExceptionPolicy. The ExceptionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ExceptionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } """ @overload @@ -1934,18 +3655,35 @@ def upsert_exception_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ExceptionPolicy. The ExceptionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ExceptionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } """ @overload def upsert_exception_policy( self, exception_policy_id: str, - resource: IO, + resource: IO[bytes], *, content_type: str = "application/merge-patch+json", if_unmodified_since: Optional[datetime.datetime] = None, @@ -1960,7 +3698,7 @@ def upsert_exception_policy( :param exception_policy_id: Id of an exception policy. Required. :type exception_policy_id: str :param resource: The resource instance. Required. - :type resource: IO + :type resource: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str @@ -1972,18 +3710,35 @@ def upsert_exception_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ExceptionPolicy. The ExceptionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ExceptionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } """ @distributed_trace def upsert_exception_policy( self, exception_policy_id: str, - resource: Union[_models.ExceptionPolicy, JSON, IO], + resource: Union[_models.ExceptionPolicy, JSON, IO[bytes]], *, if_unmodified_since: Optional[datetime.datetime] = None, etag: Optional[str] = None, @@ -1997,8 +3752,8 @@ def upsert_exception_policy( :param exception_policy_id: Id of an exception policy. Required. :type exception_policy_id: str :param resource: The resource instance. Is one of the following types: ExceptionPolicy, JSON, - IO Required. - :type resource: ~azure.communication.jobrouter.models.ExceptionPolicy or JSON or IO + IO[bytes] Required. + :type resource: ~azure.communication.jobrouter.models.ExceptionPolicy or JSON or IO[bytes] :keyword if_unmodified_since: The request should only proceed if the entity was not modified after this time. Default value is None. :paramtype if_unmodified_since: ~datetime.datetime @@ -2007,13 +3762,44 @@ def upsert_exception_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ExceptionPolicy. The ExceptionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ExceptionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } """ error_map = { 401: ClientAuthenticationError, @@ -2103,11 +3889,28 @@ def get_exception_policy(self, exception_policy_id: str, **kwargs: Any) -> _mode :param exception_policy_id: Id of an exception policy. Required. :type exception_policy_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ExceptionPolicy. The ExceptionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ExceptionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } """ error_map = { 401: ClientAuthenticationError, @@ -2161,7 +3964,7 @@ def get_exception_policy(self, exception_policy_id: str, **kwargs: Any) -> _mode return deserialized # type: ignore @distributed_trace - def list_exception_policies(self, **kwargs: Any) -> ItemPaged["_models.ExceptionPolicy"]: + def list_exception_policies(self, **kwargs: Any) -> Iterable["_models.ExceptionPolicy"]: """Retrieves existing exception policies. Retrieves existing exception policies. @@ -2169,6 +3972,25 @@ def list_exception_policies(self, **kwargs: Any) -> ItemPaged["_models.Exception :return: An iterator like instance of ExceptionPolicy :rtype: ~azure.core.paging.ItemPaged[~azure.communication.jobrouter.models.ExceptionPolicy] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } """ _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} @@ -2314,6 +4136,7 @@ def upsert_queue( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterQueue: + # pylint: disable=line-too-long """Creates or updates a queue. Creates or updates a queue. @@ -2333,11 +4156,44 @@ def upsert_queue( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterQueue. The RouterQueue is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterQueue :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } """ @overload @@ -2352,6 +4208,7 @@ def upsert_queue( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterQueue: + # pylint: disable=line-too-long """Creates or updates a queue. Creates or updates a queue. @@ -2371,18 +4228,35 @@ def upsert_queue( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterQueue. The RouterQueue is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterQueue :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } """ @overload def upsert_queue( self, queue_id: str, - resource: IO, + resource: IO[bytes], *, content_type: str = "application/merge-patch+json", if_unmodified_since: Optional[datetime.datetime] = None, @@ -2390,6 +4264,7 @@ def upsert_queue( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterQueue: + # pylint: disable=line-too-long """Creates or updates a queue. Creates or updates a queue. @@ -2397,7 +4272,7 @@ def upsert_queue( :param queue_id: Id of a queue. Required. :type queue_id: str :param resource: The resource instance. Required. - :type resource: IO + :type resource: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str @@ -2409,33 +4284,51 @@ def upsert_queue( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterQueue. The RouterQueue is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterQueue :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } """ @distributed_trace def upsert_queue( self, queue_id: str, - resource: Union[_models.RouterQueue, JSON, IO], + resource: Union[_models.RouterQueue, JSON, IO[bytes]], *, if_unmodified_since: Optional[datetime.datetime] = None, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterQueue: + # pylint: disable=line-too-long """Creates or updates a queue. Creates or updates a queue. :param queue_id: Id of a queue. Required. :type queue_id: str - :param resource: The resource instance. Is one of the following types: RouterQueue, JSON, IO - Required. - :type resource: ~azure.communication.jobrouter.models.RouterQueue or JSON or IO + :param resource: The resource instance. Is one of the following types: RouterQueue, JSON, + IO[bytes] Required. + :type resource: ~azure.communication.jobrouter.models.RouterQueue or JSON or IO[bytes] :keyword if_unmodified_since: The request should only proceed if the entity was not modified after this time. Default value is None. :paramtype if_unmodified_since: ~datetime.datetime @@ -2444,13 +4337,44 @@ def upsert_queue( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterQueue. The RouterQueue is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterQueue :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } """ error_map = { 401: ClientAuthenticationError, @@ -2534,17 +4458,35 @@ def upsert_queue( @distributed_trace def get_queue(self, queue_id: str, **kwargs: Any) -> _models.RouterQueue: + # pylint: disable=line-too-long """Retrieves an existing queue by Id. Retrieves an existing queue by Id. :param queue_id: Id of a queue. Required. :type queue_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterQueue. The RouterQueue is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterQueue :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } """ error_map = { 401: ClientAuthenticationError, @@ -2598,7 +4540,8 @@ def get_queue(self, queue_id: str, **kwargs: Any) -> _models.RouterQueue: return deserialized # type: ignore @distributed_trace - def list_queues(self, **kwargs: Any) -> ItemPaged["_models.RouterQueue"]: + def list_queues(self, **kwargs: Any) -> Iterable["_models.RouterQueue"]: + # pylint: disable=line-too-long """Retrieves existing queues. Retrieves existing queues. @@ -2606,6 +4549,25 @@ def list_queues(self, **kwargs: Any) -> ItemPaged["_models.RouterQueue"]: :return: An iterator like instance of RouterQueue :rtype: ~azure.core.paging.ItemPaged[~azure.communication.jobrouter.models.RouterQueue] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } """ _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} @@ -2751,6 +4713,7 @@ def upsert_job( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterJob: + # pylint: disable=line-too-long """Creates or updates a router job. Creates or updates a router job. @@ -2770,11 +4733,259 @@ def upsert_job( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterJob. The RouterJob is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterJob :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } """ @overload @@ -2789,6 +5000,7 @@ def upsert_job( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterJob: + # pylint: disable=line-too-long """Creates or updates a router job. Creates or updates a router job. @@ -2808,18 +5020,151 @@ def upsert_job( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterJob. The RouterJob is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterJob :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } """ @overload def upsert_job( self, job_id: str, - resource: IO, + resource: IO[bytes], *, content_type: str = "application/merge-patch+json", if_unmodified_since: Optional[datetime.datetime] = None, @@ -2827,6 +5172,7 @@ def upsert_job( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterJob: + # pylint: disable=line-too-long """Creates or updates a router job. Creates or updates a router job. @@ -2834,7 +5180,7 @@ def upsert_job( :param job_id: Id of a job. Required. :type job_id: str :param resource: The resource instance. Required. - :type resource: IO + :type resource: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str @@ -2846,33 +5192,167 @@ def upsert_job( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterJob. The RouterJob is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterJob :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } """ @distributed_trace def upsert_job( self, job_id: str, - resource: Union[_models.RouterJob, JSON, IO], + resource: Union[_models.RouterJob, JSON, IO[bytes]], *, if_unmodified_since: Optional[datetime.datetime] = None, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterJob: + # pylint: disable=line-too-long """Creates or updates a router job. Creates or updates a router job. :param job_id: Id of a job. Required. :type job_id: str - :param resource: The resource instance. Is one of the following types: RouterJob, JSON, IO - Required. - :type resource: ~azure.communication.jobrouter.models.RouterJob or JSON or IO + :param resource: The resource instance. Is one of the following types: RouterJob, JSON, + IO[bytes] Required. + :type resource: ~azure.communication.jobrouter.models.RouterJob or JSON or IO[bytes] :keyword if_unmodified_since: The request should only proceed if the entity was not modified after this time. Default value is None. :paramtype if_unmodified_since: ~datetime.datetime @@ -2881,13 +5361,259 @@ def upsert_job( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterJob. The RouterJob is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterJob :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } """ error_map = { 401: ClientAuthenticationError, @@ -2971,17 +5697,133 @@ def upsert_job( @distributed_trace def get_job(self, job_id: str, **kwargs: Any) -> _models.RouterJob: + # pylint: disable=line-too-long """Retrieves an existing job by Id. Retrieves an existing job by Id. :param job_id: Id of a job. Required. :type job_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterJob. The RouterJob is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterJob :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } """ error_map = { 401: ClientAuthenticationError, @@ -3105,7 +5947,7 @@ def _reclassify_job( # pylint: disable=protected-access @overload def _reclassify_job( # pylint: disable=protected-access - self, job_id: str, options: Optional[IO] = None, *, content_type: str = "application/json", **kwargs: Any + self, job_id: str, options: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any ) -> _models._models.ReclassifyJobResult: ... @@ -3113,7 +5955,7 @@ def _reclassify_job( # pylint: disable=protected-access def _reclassify_job( # pylint: disable=protected-access self, job_id: str, - options: Optional[Union[_models._models.ReclassifyJobOptions, JSON, IO]] = None, + options: Optional[Union[_models._models.ReclassifyJobOptions, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models._models.ReclassifyJobResult: """Reclassify a job. @@ -3123,16 +5965,17 @@ def _reclassify_job( # pylint: disable=protected-access :param job_id: Id of a job. Required. :type job_id: str :param options: Request object for reclassifying a job. Is one of the following types: - ReclassifyJobOptions, JSON, IO Default value is None. - :type options: ~azure.communication.jobrouter.models.ReclassifyJobOptions or JSON or IO - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + ReclassifyJobOptions, JSON, IO[bytes] Default value is None. + :type options: ~azure.communication.jobrouter.models.ReclassifyJobOptions or JSON or IO[bytes] :return: ReclassifyJobResult. The ReclassifyJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ReclassifyJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = {} """ error_map = { 401: ClientAuthenticationError, @@ -3215,14 +6058,15 @@ def _cancel_job( # pylint: disable=protected-access @overload def _cancel_job( # pylint: disable=protected-access - self, job_id: str, options: Optional[IO] = None, *, content_type: str = "application/json", **kwargs: Any + self, job_id: str, options: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any ) -> _models._models.CancelJobResult: ... @distributed_trace def _cancel_job( # pylint: disable=protected-access - self, job_id: str, options: Optional[Union[_models.CancelJobOptions, JSON, IO]] = None, **kwargs: Any + self, job_id: str, options: Optional[Union[_models.CancelJobOptions, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models._models.CancelJobResult: + # pylint: disable=line-too-long """Submits request to cancel an existing job by Id while supplying free-form cancellation reason. Submits request to cancel an existing job by Id while supplying free-form cancellation reason. @@ -3230,16 +6074,23 @@ def _cancel_job( # pylint: disable=protected-access :param job_id: Id of a job. Required. :type job_id: str :param options: Request model for cancelling job. Is one of the following types: - CancelJobOptions, JSON, IO Default value is None. - :type options: ~azure.communication.jobrouter.models.CancelJobOptions or JSON or IO - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + CancelJobOptions, JSON, IO[bytes] Default value is None. + :type options: ~azure.communication.jobrouter.models.CancelJobOptions or JSON or IO[bytes] :return: CancelJobResult. The CancelJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.CancelJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = { + "dispositionCode": "str", # Optional. Indicates the outcome of a job, + populate this field with your own custom values. If not provided, default value + of "Cancelled" is set. + "note": "str" # Optional. A note that will be appended to a job's Notes + collection with the current timestamp. + } """ error_map = { 401: ClientAuthenticationError, @@ -3332,7 +6183,7 @@ def _complete_job( # pylint: disable=protected-access self, job_id: str, assignment_id: str, - options: Optional[IO] = None, + options: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any @@ -3344,7 +6195,7 @@ def _complete_job( # pylint: disable=protected-access self, job_id: str, assignment_id: str, - options: Optional[Union[_models.CompleteJobOptions, JSON, IO]] = None, + options: Optional[Union[_models.CompleteJobOptions, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models._models.CompleteJobResult: """Completes an assigned job. @@ -3356,16 +6207,20 @@ def _complete_job( # pylint: disable=protected-access :param assignment_id: Id of a job assignment. Required. :type assignment_id: str :param options: Request model for completing job. Is one of the following types: - CompleteJobOptions, JSON, IO Default value is None. - :type options: ~azure.communication.jobrouter.models.CompleteJobOptions or JSON or IO - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + CompleteJobOptions, JSON, IO[bytes] Default value is None. + :type options: ~azure.communication.jobrouter.models.CompleteJobOptions or JSON or IO[bytes] :return: CompleteJobResult. The CompleteJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.CompleteJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = { + "note": "str" # Optional. A note that will be appended to a job's Notes + collection with the current timestamp. + } """ error_map = { 401: ClientAuthenticationError, @@ -3459,7 +6314,7 @@ def _close_job( # pylint: disable=protected-access self, job_id: str, assignment_id: str, - options: Optional[IO] = None, + options: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any @@ -3471,9 +6326,10 @@ def _close_job( # pylint: disable=protected-access self, job_id: str, assignment_id: str, - options: Optional[Union[_models.CloseJobOptions, JSON, IO]] = None, + options: Optional[Union[_models.CloseJobOptions, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models._models.CloseJobResult: + # pylint: disable=line-too-long """Closes a completed job. Closes a completed job. @@ -3483,16 +6339,26 @@ def _close_job( # pylint: disable=protected-access :param assignment_id: Id of a job assignment. Required. :type assignment_id: str :param options: Request model for closing job. Is one of the following types: CloseJobOptions, - JSON, IO Default value is None. - :type options: ~azure.communication.jobrouter.models.CloseJobOptions or JSON or IO - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + JSON, IO[bytes] Default value is None. + :type options: ~azure.communication.jobrouter.models.CloseJobOptions or JSON or IO[bytes] :return: CloseJobResult. The CloseJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.CloseJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = { + "closeAt": "2020-02-20 00:00:00", # Optional. If not provided, worker + capacity is released immediately along with a JobClosedEvent notification. If + provided, worker capacity is released along with a JobClosedEvent notification at + a future time in UTC. + "dispositionCode": "str", # Optional. Indicates the outcome of a job, + populate this field with your own custom values. + "note": "str" # Optional. A note that will be appended to a job's Notes + collection with the current timestamp. + } """ error_map = { 401: ClientAuthenticationError, @@ -3568,7 +6434,8 @@ def list_jobs( scheduled_before: Optional[datetime.datetime] = None, scheduled_after: Optional[datetime.datetime] = None, **kwargs: Any - ) -> ItemPaged["_models.RouterJob"]: + ) -> Iterable["_models.RouterJob"]: + # pylint: disable=line-too-long """Retrieves list of jobs based on filter parameters. Retrieves list of jobs based on filter parameters. @@ -3594,6 +6461,123 @@ def list_jobs( :return: An iterator like instance of RouterJob :rtype: ~azure.core.paging.ItemPaged[~azure.communication.jobrouter.models.RouterJob] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } """ _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} @@ -3687,12 +6671,25 @@ def get_queue_position(self, job_id: str, **kwargs: Any) -> _models.RouterJobPos :param job_id: Id of the job. Required. :type job_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterJobPositionDetails. The RouterJobPositionDetails is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterJobPositionDetails :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "estimatedWaitTimeMinutes": 0.0, # Estimated wait time of the job rounded up + to the nearest minute. Required. + "jobId": "str", # Id of the job these details are about. Required. + "position": 0, # Position of the job in question within that queue. + Required. + "queueId": "str", # Id of the queue this job is enqueued in. Required. + "queueLength": 0 # Length of the queue: total number of enqueued jobs. + Required. + } """ error_map = { 401: ClientAuthenticationError, @@ -3751,6 +6748,7 @@ def unassign_job( content_type: str = "application/json", **kwargs: Any ) -> _models.UnassignJobResult: + # pylint: disable=line-too-long """Unassign a job. Unassign a job. @@ -3764,11 +6762,25 @@ def unassign_job( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: UnassignJobResult. The UnassignJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.UnassignJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = { + "suspendMatching": bool # Optional. If SuspendMatching is true, then a job + is not queued for re-matching with a worker. + } + + # response body for status code(s): 200 + response == { + "jobId": "str", # Id of an unassigned job. Required. + "unassignmentCount": 0 # The number of times a job is unassigned. At a + maximum 3. Required. + } """ @overload @@ -3794,11 +6806,19 @@ def unassign_job( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: UnassignJobResult. The UnassignJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.UnassignJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "jobId": "str", # Id of an unassigned job. Required. + "unassignmentCount": 0 # The number of times a job is unassigned. At a + maximum 3. Required. + } """ @overload @@ -3806,7 +6826,7 @@ def unassign_job( self, job_id: str, assignment_id: str, - options: Optional[IO] = None, + options: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any @@ -3820,15 +6840,23 @@ def unassign_job( :param assignment_id: Id of a job assignment. Required. :type assignment_id: str :param options: Request body for unassign route. Default value is None. - :type options: IO + :type options: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: UnassignJobResult. The UnassignJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.UnassignJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "jobId": "str", # Id of an unassigned job. Required. + "unassignmentCount": 0 # The number of times a job is unassigned. At a + maximum 3. Required. + } """ @distributed_trace @@ -3836,9 +6864,10 @@ def unassign_job( self, job_id: str, assignment_id: str, - options: Optional[Union[_models.UnassignJobOptions, JSON, IO]] = None, + options: Optional[Union[_models.UnassignJobOptions, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models.UnassignJobResult: + # pylint: disable=line-too-long """Unassign a job. Unassign a job. @@ -3848,16 +6877,27 @@ def unassign_job( :param assignment_id: Id of a job assignment. Required. :type assignment_id: str :param options: Request body for unassign route. Is one of the following types: - UnassignJobOptions, JSON, IO Default value is None. - :type options: ~azure.communication.jobrouter.models.UnassignJobOptions or JSON or IO - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + UnassignJobOptions, JSON, IO[bytes] Default value is None. + :type options: ~azure.communication.jobrouter.models.UnassignJobOptions or JSON or IO[bytes] :return: UnassignJobResult. The UnassignJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.UnassignJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = { + "suspendMatching": bool # Optional. If SuspendMatching is true, then a job + is not queued for re-matching with a worker. + } + + # response body for status code(s): 200 + response == { + "jobId": "str", # Id of an unassigned job. Required. + "unassignmentCount": 0 # The number of times a job is unassigned. At a + maximum 3. Required. + } """ error_map = { 401: ClientAuthenticationError, @@ -3932,11 +6972,21 @@ def accept_job_offer(self, worker_id: str, offer_id: str, **kwargs: Any) -> _mod :type worker_id: str :param offer_id: Id of an offer. Required. :type offer_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: AcceptJobOfferResult. The AcceptJobOfferResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.AcceptJobOfferResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "assignmentId": "str", # Id of job assignment that assigns a worker that has + accepted an offer to a job. Required. + "jobId": "str", # Id of the job assigned. Required. + "workerId": "str" # Id of the worker that has been assigned this job. + Required. + } """ error_map = { 401: ClientAuthenticationError, @@ -4015,7 +7065,7 @@ def _decline_job_offer( # pylint: disable=protected-access self, worker_id: str, offer_id: str, - options: Optional[IO] = None, + options: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any @@ -4027,9 +7077,10 @@ def _decline_job_offer( # pylint: disable=protected-access self, worker_id: str, offer_id: str, - options: Optional[Union[_models.DeclineJobOfferOptions, JSON, IO]] = None, + options: Optional[Union[_models.DeclineJobOfferOptions, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models._models.DeclineJobOfferResult: + # pylint: disable=line-too-long """Declines an offer to work on a job. Declines an offer to work on a job. @@ -4039,16 +7090,25 @@ def _decline_job_offer( # pylint: disable=protected-access :param offer_id: Id of an offer. Required. :type offer_id: str :param options: Request model for declining offer. Is one of the following types: - DeclineJobOfferOptions, JSON, IO Default value is None. - :type options: ~azure.communication.jobrouter.models.DeclineJobOfferOptions or JSON or IO - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + DeclineJobOfferOptions, JSON, IO[bytes] Default value is None. + :type options: ~azure.communication.jobrouter.models.DeclineJobOfferOptions or JSON or + IO[bytes] :return: DeclineJobOfferResult. The DeclineJobOfferResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.DeclineJobOfferResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = { + "retryOfferAt": "2020-02-20 00:00:00" # Optional. If the RetryOfferAt is not + provided, then this job will not be offered again to the worker who declined this + job unless the worker is de-registered and re-registered. If a RetryOfferAt time + is provided, then the job will be re-matched to eligible workers at the retry + time in UTC. The worker that declined the job will also be eligible for the job + at that time. + } """ error_map = { 401: ClientAuthenticationError, @@ -4117,17 +7177,31 @@ def _decline_job_offer( # pylint: disable=protected-access @distributed_trace def get_queue_statistics(self, queue_id: str, **kwargs: Any) -> _models.RouterQueueStatistics: + # pylint: disable=line-too-long """Retrieves a queue's statistics. Retrieves a queue's statistics. :param queue_id: Id of the queue to retrieve statistics. Required. :type queue_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterQueueStatistics. The RouterQueueStatistics is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterQueueStatistics :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "length": 0, # Length of the queue: total number of enqueued jobs. Required. + "queueId": "str", # Id of the queue these details are about. Required. + "estimatedWaitTimeMinutes": { + "str": 0.0 # Optional. The estimated wait time of this queue rounded + up to the nearest minute, grouped by job priority. + }, + "longestJobWaitTimeMinutes": 0.0 # Optional. The wait time of the job that + has been enqueued in this queue for the longest. + } """ error_map = { 401: ClientAuthenticationError, @@ -4188,6 +7262,7 @@ def upsert_worker( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterWorker: + # pylint: disable=line-too-long """Creates or updates a worker. Creates or updates a worker. @@ -4207,11 +7282,132 @@ def upsert_worker( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterWorker. The RouterWorker is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterWorker :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } """ @overload @@ -4226,6 +7422,7 @@ def upsert_worker( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterWorker: + # pylint: disable=line-too-long """Creates or updates a worker. Creates or updates a worker. @@ -4245,18 +7442,79 @@ def upsert_worker( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterWorker. The RouterWorker is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterWorker :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } """ @overload def upsert_worker( self, worker_id: str, - resource: IO, + resource: IO[bytes], *, content_type: str = "application/merge-patch+json", if_unmodified_since: Optional[datetime.datetime] = None, @@ -4264,6 +7522,7 @@ def upsert_worker( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterWorker: + # pylint: disable=line-too-long """Creates or updates a worker. Creates or updates a worker. @@ -4271,7 +7530,7 @@ def upsert_worker( :param worker_id: Id of a worker. Required. :type worker_id: str :param resource: The resource instance. Required. - :type resource: IO + :type resource: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str @@ -4283,33 +7542,95 @@ def upsert_worker( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterWorker. The RouterWorker is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterWorker :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } """ @distributed_trace def upsert_worker( self, worker_id: str, - resource: Union[_models.RouterWorker, JSON, IO], + resource: Union[_models.RouterWorker, JSON, IO[bytes]], *, if_unmodified_since: Optional[datetime.datetime] = None, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterWorker: + # pylint: disable=line-too-long """Creates or updates a worker. Creates or updates a worker. :param worker_id: Id of a worker. Required. :type worker_id: str - :param resource: The resource instance. Is one of the following types: RouterWorker, JSON, IO - Required. - :type resource: ~azure.communication.jobrouter.models.RouterWorker or JSON or IO + :param resource: The resource instance. Is one of the following types: RouterWorker, JSON, + IO[bytes] Required. + :type resource: ~azure.communication.jobrouter.models.RouterWorker or JSON or IO[bytes] :keyword if_unmodified_since: The request should only proceed if the entity was not modified after this time. Default value is None. :paramtype if_unmodified_since: ~datetime.datetime @@ -4318,13 +7639,132 @@ def upsert_worker( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterWorker. The RouterWorker is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterWorker :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } """ error_map = { 401: ClientAuthenticationError, @@ -4408,17 +7848,79 @@ def upsert_worker( @distributed_trace def get_worker(self, worker_id: str, **kwargs: Any) -> _models.RouterWorker: + # pylint: disable=line-too-long """Retrieves an existing worker by Id. Retrieves an existing worker by Id. :param worker_id: Id of a worker. Required. :type worker_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterWorker. The RouterWorker is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterWorker :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } """ error_map = { 401: ClientAuthenticationError, @@ -4532,7 +8034,8 @@ def list_workers( queue_id: Optional[str] = None, has_capacity: Optional[bool] = None, **kwargs: Any - ) -> ItemPaged["_models.RouterWorker"]: + ) -> Iterable["_models.RouterWorker"]: + # pylint: disable=line-too-long """Retrieves existing workers. Retrieves existing workers. @@ -4554,6 +8057,69 @@ def list_workers( :return: An iterator like instance of RouterWorker :rtype: ~azure.core.paging.ItemPaged[~azure.communication.jobrouter.models.RouterWorker] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } """ _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_serialization.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_serialization.py index 8c265befc2aa..2f781d740827 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_serialization.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_serialization.py @@ -170,13 +170,6 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], return None -try: - basestring # type: ignore - unicode_str = unicode # type: ignore -except NameError: - basestring = str - unicode_str = str - _LOGGER = logging.getLogger(__name__) try: @@ -545,7 +538,7 @@ class Serializer(object): "multiple": lambda x, y: x % y != 0, } - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.serialize_type = { "iso-8601": Serializer.serialize_iso, "rfc-1123": Serializer.serialize_rfc, @@ -561,7 +554,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "[]": self.serialize_iter, "{}": self.serialize_dict, } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: Dict[str, type] = dict(classes) if classes else {} self.key_transformer = full_restapi_key_transformer self.client_side_validation = True @@ -649,7 +642,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): else: # That's a basic type # Integrate namespace if necessary local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) - local_node.text = unicode_str(new_attr) + local_node.text = str(new_attr) serialized.append(local_node) # type: ignore else: # JSON for k in reversed(keys): # type: ignore @@ -745,7 +738,7 @@ def query(self, name, data, data_type, **kwargs): :param str data_type: The type to be serialized from. :keyword bool skip_quote: Whether to skip quote the serialized result. Defaults to False. - :rtype: str + :rtype: str, list :raises: TypeError if serialization fails. :raises: ValueError if data is None """ @@ -994,7 +987,7 @@ def serialize_object(self, attr, **kwargs): return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) if obj_type is _long_type: return self.serialize_long(attr) - if obj_type is unicode_str: + if obj_type is str: return self.serialize_unicode(attr) if obj_type is datetime.datetime: return self.serialize_iso(attr) @@ -1370,7 +1363,7 @@ class Deserializer(object): valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.deserialize_type = { "iso-8601": Deserializer.deserialize_iso, "rfc-1123": Deserializer.deserialize_rfc, @@ -1390,7 +1383,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "duration": (isodate.Duration, datetime.timedelta), "iso-8601": (datetime.datetime), } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: Dict[str, type] = dict(classes) if classes else {} self.key_extractors = [rest_key_extractor, xml_key_extractor] # Additional properties only works if the "rest_key_extractor" is used to # extract the keys. Making it to work whatever the key extractor is too much @@ -1443,7 +1436,7 @@ def _deserialize(self, target_obj, data): response, class_name = self._classify_target(target_obj, data) - if isinstance(response, basestring): + if isinstance(response, str): return self.deserialize_data(data, response) elif isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) @@ -1514,14 +1507,14 @@ def _classify_target(self, target, data): if target is None: return None, None - if isinstance(target, basestring): + if isinstance(target, str): try: target = self.dependencies[target] except KeyError: return target, target try: - target = target._classify(data, self.dependencies) + target = target._classify(data, self.dependencies) # type: ignore except AttributeError: pass # Target is not a Model, no classify return target, target.__class__.__name__ # type: ignore @@ -1577,7 +1570,7 @@ def _unpack_content(raw_data, content_type=None): if hasattr(raw_data, "_content_consumed"): return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) - if isinstance(raw_data, (basestring, bytes)) or hasattr(raw_data, "read"): + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore return raw_data @@ -1699,7 +1692,7 @@ def deserialize_object(self, attr, **kwargs): if isinstance(attr, ET.Element): # Do no recurse on XML, just return the tree as-is return attr - if isinstance(attr, basestring): + if isinstance(attr, str): return self.deserialize_basic(attr, "str") obj_type = type(attr) if obj_type in self.basic_types: @@ -1756,7 +1749,7 @@ def deserialize_basic(self, attr, data_type): if data_type == "bool": if attr in [True, False, 1, 0]: return bool(attr) - elif isinstance(attr, basestring): + elif isinstance(attr, str): if attr.lower() in ["true", "1"]: return True elif attr.lower() in ["false", "0"]: @@ -1860,7 +1853,7 @@ def deserialize_decimal(attr): if isinstance(attr, ET.Element): attr = attr.text try: - return decimal.Decimal(attr) # type: ignore + return decimal.Decimal(str(attr)) # type: ignore except decimal.DecimalException as err: msg = "Invalid decimal {}".format(attr) raise DeserializationError(msg) from err @@ -1996,6 +1989,7 @@ def deserialize_unix(attr): if isinstance(attr, ET.Element): attr = int(attr.text) # type: ignore try: + attr = int(attr) date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) except ValueError as err: msg = "Cannot deserialize to unix datetime object." diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/models.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/models.py index 7b646472045c..d5ad25d9cdb0 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/models.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/models.py @@ -11,11 +11,13 @@ class DeprecatedEnumMeta(CaseInsensitiveEnumMeta): - def __getattribute__(cls, item): if item.upper() == "MICROSOFT_BOT": - warnings.warn("MICROSOFT_BOT is deprecated and has been replaced by \ - MICROSOFT_TEAMS_APP identifier.", DeprecationWarning) + warnings.warn( + "MICROSOFT_BOT is deprecated and has been replaced by \ + MICROSOFT_TEAMS_APP identifier.", + DeprecationWarning, + ) item = "MICROSOFT_TEAMS_APP" return super().__getattribute__(item) @@ -47,14 +49,17 @@ class CommunicationCloudEnvironment(str, Enum, metaclass=CaseInsensitiveEnumMeta @runtime_checkable class CommunicationIdentifier(Protocol): """Communication Identifier.""" + @property def raw_id(self) -> str: """The raw ID of the identifier.""" ... + @property def kind(self) -> CommunicationIdentifierKind: """The type of identifier.""" ... + @property def properties(self) -> Mapping[str, Any]: """The properties of the identifier.""" @@ -83,12 +88,14 @@ def properties(self) -> Mapping[str, Any]: class CommunicationUserProperties(TypedDict): """Dictionary of properties for a CommunicationUserIdentifier.""" + id: str """ID of the Communication user as returned from Azure Communication Identity.""" class CommunicationUserIdentifier: """Represents a user in Azure Communication Service.""" + kind: Literal[CommunicationIdentifierKind.COMMUNICATION_USER] = CommunicationIdentifierKind.COMMUNICATION_USER """The type of identifier.""" properties: CommunicationUserProperties @@ -116,12 +123,14 @@ def __eq__(self, other): class PhoneNumberProperties(TypedDict): """Dictionary of properties for a PhoneNumberIdentifier.""" + value: str """The phone number in E.164 format.""" class PhoneNumberIdentifier: """Represents a phone number.""" + kind: Literal[CommunicationIdentifierKind.PHONE_NUMBER] = CommunicationIdentifierKind.PHONE_NUMBER """The type of identifier.""" properties: PhoneNumberProperties @@ -165,6 +174,7 @@ class UnknownIdentifier: It is not advisable to rely on the `kind` property with a value `unknown`, as it could become a new or existing distinct type in the future. """ + kind: Literal[CommunicationIdentifierKind.UNKNOWN] = CommunicationIdentifierKind.UNKNOWN """The type of identifier.""" properties: Mapping[str, Any] @@ -188,6 +198,7 @@ def __eq__(self, other): class MicrosoftTeamsUserProperties(TypedDict): """Dictionary of properties for a MicrosoftTeamsUserIdentifier.""" + user_id: str """The id of the Microsoft Teams user. If the user isn't anonymous, the id is the AAD object id of the user.""" is_anonymous: bool @@ -198,6 +209,7 @@ class MicrosoftTeamsUserProperties(TypedDict): class MicrosoftTeamsUserIdentifier: """Represents an identifier for a Microsoft Teams user.""" + kind: Literal[CommunicationIdentifierKind.MICROSOFT_TEAMS_USER] = CommunicationIdentifierKind.MICROSOFT_TEAMS_USER """The type of identifier.""" properties: MicrosoftTeamsUserProperties @@ -246,6 +258,7 @@ def _format_raw_id(self, properties: MicrosoftTeamsUserProperties) -> str: class MicrosoftTeamsAppProperties(TypedDict): """Dictionary of properties for a MicrosoftTeamsAppIdentifier.""" + app_id: str """The id of the Microsoft Teams application.""" cloud: Union[CommunicationCloudEnvironment, str] @@ -254,6 +267,7 @@ class MicrosoftTeamsAppProperties(TypedDict): class _botbackcompatdict(dict): """Backwards compatible properties.""" + def __getitem__(self, __key: Any) -> Any: try: return super().__getitem__(__key) @@ -267,6 +281,7 @@ def __getitem__(self, __key: Any) -> Any: class MicrosoftTeamsAppIdentifier: """Represents an identifier for a Microsoft Teams application.""" + kind: Literal[CommunicationIdentifierKind.MICROSOFT_TEAMS_APP] = CommunicationIdentifierKind.MICROSOFT_TEAMS_APP """The type of identifier.""" properties: MicrosoftTeamsAppProperties @@ -282,10 +297,13 @@ def __init__(self, app_id: str, **kwargs: Any) -> None: :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ - self.properties = cast(MicrosoftTeamsAppProperties, _botbackcompatdict( - app_id=app_id, - cloud=kwargs.get("cloud") or CommunicationCloudEnvironment.PUBLIC, - )) + self.properties = cast( + MicrosoftTeamsAppProperties, + _botbackcompatdict( + app_id=app_id, + cloud=kwargs.get("cloud") or CommunicationCloudEnvironment.PUBLIC, + ), + ) raw_id: Optional[str] = kwargs.get("raw_id") self.raw_id = raw_id if raw_id is not None else self._format_raw_id(self.properties) @@ -323,7 +341,7 @@ def __init__(self, bot_id, **kwargs): """ warnings.warn( "The MicrosoftBotIdentifier is deprecated and has been replaced by MicrosoftTeamsAppIdentifier.", - DeprecationWarning + DeprecationWarning, ) super().__init__(bot_id, **kwargs) @@ -339,9 +357,7 @@ def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: d :rtype: CommunicationIdentifier """ if raw_id.startswith(PHONE_NUMBER_PREFIX): - return PhoneNumberIdentifier( - value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id - ) + return PhoneNumberIdentifier(value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id) segments = raw_id.split(":", maxsplit=2) if len(segments) < 3: @@ -350,9 +366,7 @@ def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: d prefix = f"{segments[0]}:{segments[1]}:" suffix = segments[2] if prefix == TEAMS_USER_ANONYMOUS_PREFIX: - return MicrosoftTeamsUserIdentifier( - user_id=suffix, is_anonymous=True, raw_id=raw_id - ) + return MicrosoftTeamsUserIdentifier(user_id=suffix, is_anonymous=True, raw_id=raw_id) if prefix == TEAMS_USER_PUBLIC_CLOUD_PREFIX: return MicrosoftTeamsUserIdentifier( user_id=suffix, diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/aio/__init__.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/aio/__init__.py index 2cad3c9bd6b0..4a879c5b9463 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/aio/__init__.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/aio/__init__.py @@ -6,8 +6,8 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._patch import JobRouterAdministrationClient -from ._patch import JobRouterClient +from ._client import JobRouterAdministrationClient +from ._client import JobRouterClient try: from ._patch import __all__ as _patch_all diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/aio/_operations/__init__.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/aio/_operations/__init__.py index 06eb1614ceb7..716a8d30dd24 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/aio/_operations/__init__.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/aio/_operations/__init__.py @@ -6,8 +6,8 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._patch import JobRouterAdministrationClientOperationsMixin -from ._patch import JobRouterClientOperationsMixin +from ._operations import JobRouterAdministrationClientOperationsMixin +from ._operations import JobRouterClientOperationsMixin from ._patch import __all__ as _patch_all from ._patch import * # pylint: disable=unused-wildcard-import diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/aio/_operations/_operations.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/aio/_operations/_operations.py index d0741ef97a49..21ac5d4c499c 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/aio/_operations/_operations.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/aio/_operations/_operations.py @@ -1,4 +1,4 @@ -# pylint: disable=too-many-lines +# pylint: disable=too-many-lines,too-many-statements # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -10,7 +10,7 @@ from io import IOBase import json import sys -from typing import Any, Callable, Dict, IO, List, Optional, TypeVar, Union, overload +from typing import Any, AsyncIterable, Callable, Dict, IO, List, Optional, TypeVar, Union, overload import urllib.parse from azure.core import MatchConditions @@ -93,6 +93,7 @@ async def upsert_distribution_policy( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.DistributionPolicy: + # pylint: disable=line-too-long """Creates or updates a distribution policy. Creates or updates a distribution policy. @@ -112,11 +113,246 @@ async def upsert_distribution_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DistributionPolicy. The DistributionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.DistributionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } """ @overload @@ -131,6 +367,7 @@ async def upsert_distribution_policy( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.DistributionPolicy: + # pylint: disable=line-too-long """Creates or updates a distribution policy. Creates or updates a distribution policy. @@ -150,18 +387,171 @@ async def upsert_distribution_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DistributionPolicy. The DistributionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.DistributionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } """ @overload async def upsert_distribution_policy( self, distribution_policy_id: str, - resource: IO, + resource: IO[bytes], *, content_type: str = "application/merge-patch+json", if_unmodified_since: Optional[datetime.datetime] = None, @@ -169,6 +559,7 @@ async def upsert_distribution_policy( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.DistributionPolicy: + # pylint: disable=line-too-long """Creates or updates a distribution policy. Creates or updates a distribution policy. @@ -176,7 +567,7 @@ async def upsert_distribution_policy( :param distribution_policy_id: Id of a distribution policy. Required. :type distribution_policy_id: str :param resource: The resource instance. Required. - :type resource: IO + :type resource: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str @@ -188,24 +579,178 @@ async def upsert_distribution_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DistributionPolicy. The DistributionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.DistributionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } """ @distributed_trace_async async def upsert_distribution_policy( self, distribution_policy_id: str, - resource: Union[_models.DistributionPolicy, JSON, IO], + resource: Union[_models.DistributionPolicy, JSON, IO[bytes]], *, if_unmodified_since: Optional[datetime.datetime] = None, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.DistributionPolicy: + # pylint: disable=line-too-long """Creates or updates a distribution policy. Creates or updates a distribution policy. @@ -213,8 +758,8 @@ async def upsert_distribution_policy( :param distribution_policy_id: Id of a distribution policy. Required. :type distribution_policy_id: str :param resource: The resource instance. Is one of the following types: DistributionPolicy, - JSON, IO Required. - :type resource: ~azure.communication.jobrouter.models.DistributionPolicy or JSON or IO + JSON, IO[bytes] Required. + :type resource: ~azure.communication.jobrouter.models.DistributionPolicy or JSON or IO[bytes] :keyword if_unmodified_since: The request should only proceed if the entity was not modified after this time. Default value is None. :paramtype if_unmodified_since: ~datetime.datetime @@ -223,13 +768,246 @@ async def upsert_distribution_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DistributionPolicy. The DistributionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.DistributionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } """ error_map = { 401: ClientAuthenticationError, @@ -313,17 +1091,100 @@ async def upsert_distribution_policy( @distributed_trace_async async def get_distribution_policy(self, distribution_policy_id: str, **kwargs: Any) -> _models.DistributionPolicy: + # pylint: disable=line-too-long """Retrieves an existing distribution policy by Id. Retrieves an existing distribution policy by Id. :param distribution_policy_id: Id of a distribution policy. Required. :type distribution_policy_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DistributionPolicy. The DistributionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.DistributionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } """ error_map = { 401: ClientAuthenticationError, @@ -377,7 +1238,8 @@ async def get_distribution_policy(self, distribution_policy_id: str, **kwargs: A return deserialized # type: ignore @distributed_trace - def list_distribution_policies(self, **kwargs: Any) -> AsyncItemPaged["_models.DistributionPolicy"]: + def list_distribution_policies(self, **kwargs: Any) -> AsyncIterable["_models.DistributionPolicy"]: + # pylint: disable=line-too-long """Retrieves existing distribution policies. Retrieves existing distribution policies. @@ -386,6 +1248,90 @@ def list_distribution_policies(self, **kwargs: Any) -> AsyncItemPaged["_models.D :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.communication.jobrouter.models.DistributionPolicy] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "bestWorker": + distribution_mode = { + "kind": "bestWorker", + "bypassSelectors": bool, # Optional. If set to true, then router will match + workers to jobs even if they don't match label selectors. Warning: You may get + workers that are not qualified for a job they are matched with if you set this + variable to true. This flag is intended more for temporary usage. By default, set + to false. + "maxConcurrentOffers": 0, # Optional. Governs the maximum number of active + concurrent offers a job can have. + "minConcurrentOffers": 0, # Optional. Governs the minimum desired number of + active concurrent offers a job can have. + "scoringRule": router_rule, + "scoringRuleOptions": { + "batchSize": 0, # Optional. Set batch size when + 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. + "descendingOrder": bool, # Optional. If false, will sort scores by + ascending order. By default, set to true. + "isBatchScoringEnabled": bool, # Optional. If set to true, will + score workers in batches, and the parameter name of the worker labels will be + sent as ``workers``. By default, set to false and the parameter name for the + worker labels will be sent as ``worker``. Note: If enabled, use 'batchSize' + to set batch size. + "scoringParameters": [ + "str" # Optional. List of extra parameters from a job that + will be sent as part of the payload to scoring rule. If not set, a job's + labels (sent in the payload as ``job``"" ) and a job's worker selectors + (sent in the payload as ``selectors``"" ) are added to the payload of the + scoring rule by default. Note: Worker labels are always sent with scoring + payload. + ] + } + } + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a distribution policy. Required. + "mode": distribution_mode, + "name": "str", # Optional. Friendly name of this policy. + "offerExpiresAfterSeconds": 0.0 # Optional. Number of seconds after which + any offers created under this policy will be expired. + } """ _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} @@ -531,6 +1477,7 @@ async def upsert_classification_policy( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.ClassificationPolicy: + # pylint: disable=line-too-long """Creates or updates a classification policy. Creates or updates a classification policy. @@ -550,11 +1497,195 @@ async def upsert_classification_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ClassificationPolicy. The ClassificationPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ClassificationPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } """ @overload @@ -569,6 +1700,7 @@ async def upsert_classification_policy( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.ClassificationPolicy: + # pylint: disable=line-too-long """Creates or updates a classification policy. Creates or updates a classification policy. @@ -588,18 +1720,135 @@ async def upsert_classification_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ClassificationPolicy. The ClassificationPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ClassificationPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } """ @overload async def upsert_classification_policy( self, classification_policy_id: str, - resource: IO, + resource: IO[bytes], *, content_type: str = "application/merge-patch+json", if_unmodified_since: Optional[datetime.datetime] = None, @@ -607,6 +1856,7 @@ async def upsert_classification_policy( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.ClassificationPolicy: + # pylint: disable=line-too-long """Creates or updates a classification policy. Creates or updates a classification policy. @@ -614,7 +1864,7 @@ async def upsert_classification_policy( :param classification_policy_id: Id of a classification policy. Required. :type classification_policy_id: str :param resource: The resource instance. Required. - :type resource: IO + :type resource: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str @@ -626,48 +1876,348 @@ async def upsert_classification_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ClassificationPolicy. The ClassificationPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ClassificationPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } """ @distributed_trace_async async def upsert_classification_policy( self, classification_policy_id: str, - resource: Union[_models.ClassificationPolicy, JSON, IO], + resource: Union[_models.ClassificationPolicy, JSON, IO[bytes]], *, if_unmodified_since: Optional[datetime.datetime] = None, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.ClassificationPolicy: + # pylint: disable=line-too-long """Creates or updates a classification policy. Creates or updates a classification policy. - :param classification_policy_id: Id of a classification policy. Required. - :type classification_policy_id: str - :param resource: The resource instance. Is one of the following types: ClassificationPolicy, - JSON, IO Required. - :type resource: ~azure.communication.jobrouter.models.ClassificationPolicy or JSON or IO - :keyword if_unmodified_since: The request should only proceed if the entity was not modified - after this time. Default value is None. - :paramtype if_unmodified_since: ~datetime.datetime - :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is - None. - :paramtype etag: str - :keyword match_condition: The match condition to use upon the etag. Default value is None. - :paramtype match_condition: ~azure.core.MatchConditions - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: ClassificationPolicy. The ClassificationPolicy is compatible with MutableMapping - :rtype: ~azure.communication.jobrouter.models.ClassificationPolicy - :raises ~azure.core.exceptions.HttpResponseError: + :param classification_policy_id: Id of a classification policy. Required. + :type classification_policy_id: str + :param resource: The resource instance. Is one of the following types: ClassificationPolicy, + JSON, IO[bytes] Required. + :type resource: ~azure.communication.jobrouter.models.ClassificationPolicy or JSON or IO[bytes] + :keyword if_unmodified_since: The request should only proceed if the entity was not modified + after this time. Default value is None. + :paramtype if_unmodified_since: ~datetime.datetime + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ClassificationPolicy. The ClassificationPolicy is compatible with MutableMapping + :rtype: ~azure.communication.jobrouter.models.ClassificationPolicy + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } """ error_map = { 401: ClientAuthenticationError, @@ -753,17 +2303,85 @@ async def upsert_classification_policy( async def get_classification_policy( self, classification_policy_id: str, **kwargs: Any ) -> _models.ClassificationPolicy: + # pylint: disable=line-too-long """Retrieves an existing classification policy by Id. Retrieves an existing classification policy by Id. :param classification_policy_id: Id of a classification policy. Required. :type classification_policy_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ClassificationPolicy. The ClassificationPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ClassificationPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } """ error_map = { 401: ClientAuthenticationError, @@ -817,7 +2435,8 @@ async def get_classification_policy( return deserialized # type: ignore @distributed_trace - def list_classification_policies(self, **kwargs: Any) -> AsyncItemPaged["_models.ClassificationPolicy"]: + def list_classification_policies(self, **kwargs: Any) -> AsyncIterable["_models.ClassificationPolicy"]: + # pylint: disable=line-too-long """Retrieves existing classification policies. Retrieves existing classification policies. @@ -826,6 +2445,75 @@ def list_classification_policies(self, **kwargs: Any) -> AsyncItemPaged["_models :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.communication.jobrouter.models.ClassificationPolicy] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "directMap": + router_rule = { + "kind": "directMap" + } + + # JSON input template for discriminator value "expression": + router_rule = { + "expression": "str", # An expression to evaluate. Should contain return + statement with calculated values. Required. + "kind": "expression", + "language": "str" # Optional. The expression language to compile to and + execute. "powerFx" + } + + # JSON input template for discriminator value "function": + router_rule = { + "functionUri": "str", # URL for Azure Function. Required. + "kind": "function", + "credential": { + "appKey": "str", # Optional. Access key scoped to a Azure Function + app. This key grants access to all functions under the app. + "clientId": "str", # Optional. Client id, when AppKey is provided In + context of Azure function, this is usually the name of the key. + "functionKey": "str" # Optional. Access key scoped to a particular + function. + } + } + + # JSON input template for discriminator value "static": + router_rule = { + "kind": "static", + "value": {} # Optional. The static value this rule always returns. Values + must be primitive values - number, string, boolean. + } + + # JSON input template for discriminator value "webhook": + router_rule = { + "kind": "webhook", + "authorizationServerUri": "str", # Optional. Uri for Authorization Server. + "clientCredential": { + "clientId": "str", # Optional. ClientId for Contoso Authorization + server. + "clientSecret": "str" # Optional. Client secret for Contoso + Authorization server. + }, + "webhookUri": "str" # Optional. Uri for Contoso's Web Server. + } + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a classification policy. Required. + "fallbackQueueId": "str", # Optional. Id of a fallback queue to select if + queue selector attachments doesn't find a match. + "name": "str", # Optional. Friendly name of this policy. + "prioritizationRule": router_rule, + "queueSelectorAttachments": [ + queue_selector_attachment + ], + "workerSelectorAttachments": [ + worker_selector_attachment + ] + } """ _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} @@ -990,11 +2678,44 @@ async def upsert_exception_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ExceptionPolicy. The ExceptionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ExceptionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } """ @overload @@ -1028,18 +2749,35 @@ async def upsert_exception_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ExceptionPolicy. The ExceptionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ExceptionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } """ @overload async def upsert_exception_policy( self, exception_policy_id: str, - resource: IO, + resource: IO[bytes], *, content_type: str = "application/merge-patch+json", if_unmodified_since: Optional[datetime.datetime] = None, @@ -1054,7 +2792,7 @@ async def upsert_exception_policy( :param exception_policy_id: Id of an exception policy. Required. :type exception_policy_id: str :param resource: The resource instance. Required. - :type resource: IO + :type resource: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str @@ -1066,18 +2804,35 @@ async def upsert_exception_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ExceptionPolicy. The ExceptionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ExceptionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } """ @distributed_trace_async async def upsert_exception_policy( self, exception_policy_id: str, - resource: Union[_models.ExceptionPolicy, JSON, IO], + resource: Union[_models.ExceptionPolicy, JSON, IO[bytes]], *, if_unmodified_since: Optional[datetime.datetime] = None, etag: Optional[str] = None, @@ -1091,8 +2846,8 @@ async def upsert_exception_policy( :param exception_policy_id: Id of an exception policy. Required. :type exception_policy_id: str :param resource: The resource instance. Is one of the following types: ExceptionPolicy, JSON, - IO Required. - :type resource: ~azure.communication.jobrouter.models.ExceptionPolicy or JSON or IO + IO[bytes] Required. + :type resource: ~azure.communication.jobrouter.models.ExceptionPolicy or JSON or IO[bytes] :keyword if_unmodified_since: The request should only proceed if the entity was not modified after this time. Default value is None. :paramtype if_unmodified_since: ~datetime.datetime @@ -1101,13 +2856,44 @@ async def upsert_exception_policy( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ExceptionPolicy. The ExceptionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ExceptionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } """ error_map = { 401: ClientAuthenticationError, @@ -1197,11 +2983,28 @@ async def get_exception_policy(self, exception_policy_id: str, **kwargs: Any) -> :param exception_policy_id: Id of an exception policy. Required. :type exception_policy_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ExceptionPolicy. The ExceptionPolicy is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ExceptionPolicy :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } """ error_map = { 401: ClientAuthenticationError, @@ -1255,7 +3058,7 @@ async def get_exception_policy(self, exception_policy_id: str, **kwargs: Any) -> return deserialized # type: ignore @distributed_trace - def list_exception_policies(self, **kwargs: Any) -> AsyncItemPaged["_models.ExceptionPolicy"]: + def list_exception_policies(self, **kwargs: Any) -> AsyncIterable["_models.ExceptionPolicy"]: """Retrieves existing exception policies. Retrieves existing exception policies. @@ -1264,6 +3067,25 @@ def list_exception_policies(self, **kwargs: Any) -> AsyncItemPaged["_models.Exce :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.communication.jobrouter.models.ExceptionPolicy] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of an exception policy. Required. + "exceptionRules": [ + { + "actions": [ + exception_action + ], + "id": "str", # Id of an exception rule. Required. + "trigger": exception_trigger + } + ], + "name": "str" # Optional. Friendly name of this policy. + } """ _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} @@ -1409,6 +3231,7 @@ async def upsert_queue( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterQueue: + # pylint: disable=line-too-long """Creates or updates a queue. Creates or updates a queue. @@ -1428,11 +3251,44 @@ async def upsert_queue( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterQueue. The RouterQueue is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterQueue :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } """ @overload @@ -1447,6 +3303,7 @@ async def upsert_queue( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterQueue: + # pylint: disable=line-too-long """Creates or updates a queue. Creates or updates a queue. @@ -1466,18 +3323,35 @@ async def upsert_queue( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterQueue. The RouterQueue is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterQueue :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } """ @overload async def upsert_queue( self, queue_id: str, - resource: IO, + resource: IO[bytes], *, content_type: str = "application/merge-patch+json", if_unmodified_since: Optional[datetime.datetime] = None, @@ -1485,6 +3359,7 @@ async def upsert_queue( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterQueue: + # pylint: disable=line-too-long """Creates or updates a queue. Creates or updates a queue. @@ -1492,7 +3367,7 @@ async def upsert_queue( :param queue_id: Id of a queue. Required. :type queue_id: str :param resource: The resource instance. Required. - :type resource: IO + :type resource: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str @@ -1504,33 +3379,51 @@ async def upsert_queue( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterQueue. The RouterQueue is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterQueue :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } """ @distributed_trace_async async def upsert_queue( self, queue_id: str, - resource: Union[_models.RouterQueue, JSON, IO], + resource: Union[_models.RouterQueue, JSON, IO[bytes]], *, if_unmodified_since: Optional[datetime.datetime] = None, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterQueue: + # pylint: disable=line-too-long """Creates or updates a queue. Creates or updates a queue. :param queue_id: Id of a queue. Required. :type queue_id: str - :param resource: The resource instance. Is one of the following types: RouterQueue, JSON, IO - Required. - :type resource: ~azure.communication.jobrouter.models.RouterQueue or JSON or IO + :param resource: The resource instance. Is one of the following types: RouterQueue, JSON, + IO[bytes] Required. + :type resource: ~azure.communication.jobrouter.models.RouterQueue or JSON or IO[bytes] :keyword if_unmodified_since: The request should only proceed if the entity was not modified after this time. Default value is None. :paramtype if_unmodified_since: ~datetime.datetime @@ -1539,13 +3432,44 @@ async def upsert_queue( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterQueue. The RouterQueue is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterQueue :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } """ error_map = { 401: ClientAuthenticationError, @@ -1629,17 +3553,35 @@ async def upsert_queue( @distributed_trace_async async def get_queue(self, queue_id: str, **kwargs: Any) -> _models.RouterQueue: + # pylint: disable=line-too-long """Retrieves an existing queue by Id. Retrieves an existing queue by Id. :param queue_id: Id of a queue. Required. :type queue_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterQueue. The RouterQueue is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterQueue :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } """ error_map = { 401: ClientAuthenticationError, @@ -1693,7 +3635,8 @@ async def get_queue(self, queue_id: str, **kwargs: Any) -> _models.RouterQueue: return deserialized # type: ignore @distributed_trace - def list_queues(self, **kwargs: Any) -> AsyncItemPaged["_models.RouterQueue"]: + def list_queues(self, **kwargs: Any) -> AsyncIterable["_models.RouterQueue"]: + # pylint: disable=line-too-long """Retrieves existing queues. Retrieves existing queues. @@ -1702,6 +3645,25 @@ def list_queues(self, **kwargs: Any) -> AsyncItemPaged["_models.RouterQueue"]: :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.communication.jobrouter.models.RouterQueue] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a queue. Required. + "distributionPolicyId": "str", # Optional. Id of a distribution policy that + will determine how a job is distributed to workers. + "exceptionPolicyId": "str", # Optional. Id of an exception policy that + determines various job escalation rules. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "name": "str" # Optional. Friendly name of this queue. + } """ _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} @@ -1849,6 +3811,7 @@ async def upsert_job( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterJob: + # pylint: disable=line-too-long """Creates or updates a router job. Creates or updates a router job. @@ -1868,11 +3831,259 @@ async def upsert_job( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterJob. The RouterJob is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterJob :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } """ @overload @@ -1887,6 +4098,7 @@ async def upsert_job( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterJob: + # pylint: disable=line-too-long """Creates or updates a router job. Creates or updates a router job. @@ -1906,18 +4118,151 @@ async def upsert_job( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterJob. The RouterJob is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterJob :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } """ @overload async def upsert_job( self, job_id: str, - resource: IO, + resource: IO[bytes], *, content_type: str = "application/merge-patch+json", if_unmodified_since: Optional[datetime.datetime] = None, @@ -1925,6 +4270,7 @@ async def upsert_job( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterJob: + # pylint: disable=line-too-long """Creates or updates a router job. Creates or updates a router job. @@ -1932,7 +4278,7 @@ async def upsert_job( :param job_id: Id of a job. Required. :type job_id: str :param resource: The resource instance. Required. - :type resource: IO + :type resource: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str @@ -1944,33 +4290,167 @@ async def upsert_job( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterJob. The RouterJob is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterJob :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } """ @distributed_trace_async async def upsert_job( self, job_id: str, - resource: Union[_models.RouterJob, JSON, IO], + resource: Union[_models.RouterJob, JSON, IO[bytes]], *, if_unmodified_since: Optional[datetime.datetime] = None, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterJob: + # pylint: disable=line-too-long """Creates or updates a router job. Creates or updates a router job. :param job_id: Id of a job. Required. :type job_id: str - :param resource: The resource instance. Is one of the following types: RouterJob, JSON, IO - Required. - :type resource: ~azure.communication.jobrouter.models.RouterJob or JSON or IO + :param resource: The resource instance. Is one of the following types: RouterJob, JSON, + IO[bytes] Required. + :type resource: ~azure.communication.jobrouter.models.RouterJob or JSON or IO[bytes] :keyword if_unmodified_since: The request should only proceed if the entity was not modified after this time. Default value is None. :paramtype if_unmodified_since: ~datetime.datetime @@ -1979,13 +4459,259 @@ async def upsert_job( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterJob. The RouterJob is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterJob :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } """ error_map = { 401: ClientAuthenticationError, @@ -2069,17 +4795,133 @@ async def upsert_job( @distributed_trace_async async def get_job(self, job_id: str, **kwargs: Any) -> _models.RouterJob: + # pylint: disable=line-too-long """Retrieves an existing job by Id. Retrieves an existing job by Id. :param job_id: Id of a job. Required. :type job_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterJob. The RouterJob is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterJob :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } """ error_map = { 401: ClientAuthenticationError, @@ -2203,7 +5045,7 @@ async def _reclassify_job( # pylint: disable=protected-access @overload async def _reclassify_job( # pylint: disable=protected-access - self, job_id: str, options: Optional[IO] = None, *, content_type: str = "application/json", **kwargs: Any + self, job_id: str, options: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any ) -> _models._models.ReclassifyJobResult: ... @@ -2211,7 +5053,7 @@ async def _reclassify_job( # pylint: disable=protected-access async def _reclassify_job( # pylint: disable=protected-access self, job_id: str, - options: Optional[Union[_models._models.ReclassifyJobOptions, JSON, IO]] = None, + options: Optional[Union[_models._models.ReclassifyJobOptions, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models._models.ReclassifyJobResult: """Reclassify a job. @@ -2221,16 +5063,17 @@ async def _reclassify_job( # pylint: disable=protected-access :param job_id: Id of a job. Required. :type job_id: str :param options: Request object for reclassifying a job. Is one of the following types: - ReclassifyJobOptions, JSON, IO Default value is None. - :type options: ~azure.communication.jobrouter.models.ReclassifyJobOptions or JSON or IO - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + ReclassifyJobOptions, JSON, IO[bytes] Default value is None. + :type options: ~azure.communication.jobrouter.models.ReclassifyJobOptions or JSON or IO[bytes] :return: ReclassifyJobResult. The ReclassifyJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.ReclassifyJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = {} """ error_map = { 401: ClientAuthenticationError, @@ -2313,14 +5156,15 @@ async def _cancel_job( # pylint: disable=protected-access @overload async def _cancel_job( # pylint: disable=protected-access - self, job_id: str, options: Optional[IO] = None, *, content_type: str = "application/json", **kwargs: Any + self, job_id: str, options: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any ) -> _models._models.CancelJobResult: ... @distributed_trace_async async def _cancel_job( # pylint: disable=protected-access - self, job_id: str, options: Optional[Union[_models.CancelJobOptions, JSON, IO]] = None, **kwargs: Any + self, job_id: str, options: Optional[Union[_models.CancelJobOptions, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models._models.CancelJobResult: + # pylint: disable=line-too-long """Submits request to cancel an existing job by Id while supplying free-form cancellation reason. Submits request to cancel an existing job by Id while supplying free-form cancellation reason. @@ -2328,16 +5172,23 @@ async def _cancel_job( # pylint: disable=protected-access :param job_id: Id of a job. Required. :type job_id: str :param options: Request model for cancelling job. Is one of the following types: - CancelJobOptions, JSON, IO Default value is None. - :type options: ~azure.communication.jobrouter.models.CancelJobOptions or JSON or IO - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + CancelJobOptions, JSON, IO[bytes] Default value is None. + :type options: ~azure.communication.jobrouter.models.CancelJobOptions or JSON or IO[bytes] :return: CancelJobResult. The CancelJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.CancelJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = { + "dispositionCode": "str", # Optional. Indicates the outcome of a job, + populate this field with your own custom values. If not provided, default value + of "Cancelled" is set. + "note": "str" # Optional. A note that will be appended to a job's Notes + collection with the current timestamp. + } """ error_map = { 401: ClientAuthenticationError, @@ -2430,7 +5281,7 @@ async def _complete_job( # pylint: disable=protected-access self, job_id: str, assignment_id: str, - options: Optional[IO] = None, + options: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any @@ -2442,7 +5293,7 @@ async def _complete_job( # pylint: disable=protected-access self, job_id: str, assignment_id: str, - options: Optional[Union[_models.CompleteJobOptions, JSON, IO]] = None, + options: Optional[Union[_models.CompleteJobOptions, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models._models.CompleteJobResult: """Completes an assigned job. @@ -2454,16 +5305,20 @@ async def _complete_job( # pylint: disable=protected-access :param assignment_id: Id of a job assignment. Required. :type assignment_id: str :param options: Request model for completing job. Is one of the following types: - CompleteJobOptions, JSON, IO Default value is None. - :type options: ~azure.communication.jobrouter.models.CompleteJobOptions or JSON or IO - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + CompleteJobOptions, JSON, IO[bytes] Default value is None. + :type options: ~azure.communication.jobrouter.models.CompleteJobOptions or JSON or IO[bytes] :return: CompleteJobResult. The CompleteJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.CompleteJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = { + "note": "str" # Optional. A note that will be appended to a job's Notes + collection with the current timestamp. + } """ error_map = { 401: ClientAuthenticationError, @@ -2557,7 +5412,7 @@ async def _close_job( # pylint: disable=protected-access self, job_id: str, assignment_id: str, - options: Optional[IO] = None, + options: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any @@ -2569,9 +5424,10 @@ async def _close_job( # pylint: disable=protected-access self, job_id: str, assignment_id: str, - options: Optional[Union[_models.CloseJobOptions, JSON, IO]] = None, + options: Optional[Union[_models.CloseJobOptions, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models._models.CloseJobResult: + # pylint: disable=line-too-long """Closes a completed job. Closes a completed job. @@ -2581,16 +5437,26 @@ async def _close_job( # pylint: disable=protected-access :param assignment_id: Id of a job assignment. Required. :type assignment_id: str :param options: Request model for closing job. Is one of the following types: CloseJobOptions, - JSON, IO Default value is None. - :type options: ~azure.communication.jobrouter.models.CloseJobOptions or JSON or IO - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + JSON, IO[bytes] Default value is None. + :type options: ~azure.communication.jobrouter.models.CloseJobOptions or JSON or IO[bytes] :return: CloseJobResult. The CloseJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.CloseJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = { + "closeAt": "2020-02-20 00:00:00", # Optional. If not provided, worker + capacity is released immediately along with a JobClosedEvent notification. If + provided, worker capacity is released along with a JobClosedEvent notification at + a future time in UTC. + "dispositionCode": "str", # Optional. Indicates the outcome of a job, + populate this field with your own custom values. + "note": "str" # Optional. A note that will be appended to a job's Notes + collection with the current timestamp. + } """ error_map = { 401: ClientAuthenticationError, @@ -2666,7 +5532,8 @@ def list_jobs( scheduled_before: Optional[datetime.datetime] = None, scheduled_after: Optional[datetime.datetime] = None, **kwargs: Any - ) -> AsyncItemPaged["_models.RouterJob"]: + ) -> AsyncIterable["_models.RouterJob"]: + # pylint: disable=line-too-long """Retrieves list of jobs based on filter parameters. Retrieves list of jobs based on filter parameters. @@ -2693,6 +5560,123 @@ def list_jobs( :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.communication.jobrouter.models.RouterJob] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "queueAndMatch": + job_matching_mode = { + "kind": "queueAndMatch" + } + + # JSON input template for discriminator value "scheduleAndSuspend": + job_matching_mode = { + "kind": "scheduleAndSuspend", + "scheduleAt": "2020-02-20 00:00:00" # Requested schedule time. Required. + } + + # JSON input template for discriminator value "suspend": + job_matching_mode = { + "kind": "suspend" + } + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a job. Required. + "assignments": { + "str": { + "assignedAt": "2020-02-20 00:00:00", # Timestamp when the + job was assigned to a worker in UTC. Required. + "assignmentId": "str", # Id of a job assignment. Required. + "closedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as closed after being completed in UTC. + "completedAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the job was marked as completed after being assigned in UTC. + "workerId": "str" # Optional. Id of the Worker assigned to + the job. + } + }, + "attachedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "channelId": "str", # Optional. The channel identifier. eg. voice, chat, + etc. + "channelReference": "str", # Optional. Reference to an external parent + context, eg. call ID. + "classificationPolicyId": "str", # Optional. Id of a classification policy + used for classifying this job. + "dispositionCode": "str", # Optional. Reason code for cancelled or closed + jobs. + "enqueuedAt": "2020-02-20 00:00:00", # Optional. Timestamp a job was queued + in UTC. + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "matchingMode": job_matching_mode, + "notes": [ + { + "message": "str", # The message contained in the note. + Required. + "addedAt": "2020-02-20 00:00:00" # Optional. The time at + which the note was added in UTC. If not provided, will default to the + current time. + } + ], + "priority": 0, # Optional. Priority of this job. + "queueId": "str", # Optional. Id of a queue that this job is queued to. + "requestedWorkerSelectors": [ + { + "key": "str", # The label key to query against. Required. + "labelOperator": "str", # Describes how the value of the + label is compared to the value defined on the worker selector. Required. + Known values are: "equal", "notEqual", "lessThan", "lessThanOrEqual", + "greaterThan", and "greaterThanOrEqual". + "expedite": bool, # Optional. Pushes a job to the front of + the queue as long as this selector is active. + "expiresAfterSeconds": 0.0, # Optional. Describes how long + this label selector is valid in seconds. + "expiresAt": "2020-02-20 00:00:00", # Optional. The time at + which this worker selector expires in UTC. + "status": "str", # Optional. Status of the worker selector. + Known values are: "active" and "expired". + "value": {} # Optional. The value to compare against the + actual label value with the given operator. Values must be primitive + values - number, string, boolean. + } + ], + "scheduledAt": "2020-02-20 00:00:00", # Optional. If set, job will be + scheduled to be enqueued at a given time. + "status": "str", # Optional. The status of the job. Known values are: + "pendingClassification", "queued", "assigned", "completed", "closed", + "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", + "scheduleFailed", and "waitingForActivation". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this job. Values must be primitive values - number, string, boolean. + } + } """ _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} @@ -2786,12 +5770,25 @@ async def get_queue_position(self, job_id: str, **kwargs: Any) -> _models.Router :param job_id: Id of the job. Required. :type job_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterJobPositionDetails. The RouterJobPositionDetails is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterJobPositionDetails :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "estimatedWaitTimeMinutes": 0.0, # Estimated wait time of the job rounded up + to the nearest minute. Required. + "jobId": "str", # Id of the job these details are about. Required. + "position": 0, # Position of the job in question within that queue. + Required. + "queueId": "str", # Id of the queue this job is enqueued in. Required. + "queueLength": 0 # Length of the queue: total number of enqueued jobs. + Required. + } """ error_map = { 401: ClientAuthenticationError, @@ -2850,6 +5847,7 @@ async def unassign_job( content_type: str = "application/json", **kwargs: Any ) -> _models.UnassignJobResult: + # pylint: disable=line-too-long """Unassign a job. Unassign a job. @@ -2863,11 +5861,25 @@ async def unassign_job( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: UnassignJobResult. The UnassignJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.UnassignJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = { + "suspendMatching": bool # Optional. If SuspendMatching is true, then a job + is not queued for re-matching with a worker. + } + + # response body for status code(s): 200 + response == { + "jobId": "str", # Id of an unassigned job. Required. + "unassignmentCount": 0 # The number of times a job is unassigned. At a + maximum 3. Required. + } """ @overload @@ -2893,11 +5905,19 @@ async def unassign_job( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: UnassignJobResult. The UnassignJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.UnassignJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "jobId": "str", # Id of an unassigned job. Required. + "unassignmentCount": 0 # The number of times a job is unassigned. At a + maximum 3. Required. + } """ @overload @@ -2905,7 +5925,7 @@ async def unassign_job( self, job_id: str, assignment_id: str, - options: Optional[IO] = None, + options: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any @@ -2919,15 +5939,23 @@ async def unassign_job( :param assignment_id: Id of a job assignment. Required. :type assignment_id: str :param options: Request body for unassign route. Default value is None. - :type options: IO + :type options: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: UnassignJobResult. The UnassignJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.UnassignJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "jobId": "str", # Id of an unassigned job. Required. + "unassignmentCount": 0 # The number of times a job is unassigned. At a + maximum 3. Required. + } """ @distributed_trace_async @@ -2935,9 +5963,10 @@ async def unassign_job( self, job_id: str, assignment_id: str, - options: Optional[Union[_models.UnassignJobOptions, JSON, IO]] = None, + options: Optional[Union[_models.UnassignJobOptions, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models.UnassignJobResult: + # pylint: disable=line-too-long """Unassign a job. Unassign a job. @@ -2947,16 +5976,27 @@ async def unassign_job( :param assignment_id: Id of a job assignment. Required. :type assignment_id: str :param options: Request body for unassign route. Is one of the following types: - UnassignJobOptions, JSON, IO Default value is None. - :type options: ~azure.communication.jobrouter.models.UnassignJobOptions or JSON or IO - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + UnassignJobOptions, JSON, IO[bytes] Default value is None. + :type options: ~azure.communication.jobrouter.models.UnassignJobOptions or JSON or IO[bytes] :return: UnassignJobResult. The UnassignJobResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.UnassignJobResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = { + "suspendMatching": bool # Optional. If SuspendMatching is true, then a job + is not queued for re-matching with a worker. + } + + # response body for status code(s): 200 + response == { + "jobId": "str", # Id of an unassigned job. Required. + "unassignmentCount": 0 # The number of times a job is unassigned. At a + maximum 3. Required. + } """ error_map = { 401: ClientAuthenticationError, @@ -3031,11 +6071,21 @@ async def accept_job_offer(self, worker_id: str, offer_id: str, **kwargs: Any) - :type worker_id: str :param offer_id: Id of an offer. Required. :type offer_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: AcceptJobOfferResult. The AcceptJobOfferResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.AcceptJobOfferResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "assignmentId": "str", # Id of job assignment that assigns a worker that has + accepted an offer to a job. Required. + "jobId": "str", # Id of the job assigned. Required. + "workerId": "str" # Id of the worker that has been assigned this job. + Required. + } """ error_map = { 401: ClientAuthenticationError, @@ -3114,7 +6164,7 @@ async def _decline_job_offer( # pylint: disable=protected-access self, worker_id: str, offer_id: str, - options: Optional[IO] = None, + options: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any @@ -3126,9 +6176,10 @@ async def _decline_job_offer( # pylint: disable=protected-access self, worker_id: str, offer_id: str, - options: Optional[Union[_models.DeclineJobOfferOptions, JSON, IO]] = None, + options: Optional[Union[_models.DeclineJobOfferOptions, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models._models.DeclineJobOfferResult: + # pylint: disable=line-too-long """Declines an offer to work on a job. Declines an offer to work on a job. @@ -3138,16 +6189,25 @@ async def _decline_job_offer( # pylint: disable=protected-access :param offer_id: Id of an offer. Required. :type offer_id: str :param options: Request model for declining offer. Is one of the following types: - DeclineJobOfferOptions, JSON, IO Default value is None. - :type options: ~azure.communication.jobrouter.models.DeclineJobOfferOptions or JSON or IO - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + DeclineJobOfferOptions, JSON, IO[bytes] Default value is None. + :type options: ~azure.communication.jobrouter.models.DeclineJobOfferOptions or JSON or + IO[bytes] :return: DeclineJobOfferResult. The DeclineJobOfferResult is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.DeclineJobOfferResult :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + options = { + "retryOfferAt": "2020-02-20 00:00:00" # Optional. If the RetryOfferAt is not + provided, then this job will not be offered again to the worker who declined this + job unless the worker is de-registered and re-registered. If a RetryOfferAt time + is provided, then the job will be re-matched to eligible workers at the retry + time in UTC. The worker that declined the job will also be eligible for the job + at that time. + } """ error_map = { 401: ClientAuthenticationError, @@ -3216,17 +6276,31 @@ async def _decline_job_offer( # pylint: disable=protected-access @distributed_trace_async async def get_queue_statistics(self, queue_id: str, **kwargs: Any) -> _models.RouterQueueStatistics: + # pylint: disable=line-too-long """Retrieves a queue's statistics. Retrieves a queue's statistics. :param queue_id: Id of the queue to retrieve statistics. Required. :type queue_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterQueueStatistics. The RouterQueueStatistics is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterQueueStatistics :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "length": 0, # Length of the queue: total number of enqueued jobs. Required. + "queueId": "str", # Id of the queue these details are about. Required. + "estimatedWaitTimeMinutes": { + "str": 0.0 # Optional. The estimated wait time of this queue rounded + up to the nearest minute, grouped by job priority. + }, + "longestJobWaitTimeMinutes": 0.0 # Optional. The wait time of the job that + has been enqueued in this queue for the longest. + } """ error_map = { 401: ClientAuthenticationError, @@ -3287,6 +6361,7 @@ async def upsert_worker( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterWorker: + # pylint: disable=line-too-long """Creates or updates a worker. Creates or updates a worker. @@ -3306,11 +6381,132 @@ async def upsert_worker( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterWorker. The RouterWorker is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterWorker :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } """ @overload @@ -3325,6 +6521,7 @@ async def upsert_worker( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterWorker: + # pylint: disable=line-too-long """Creates or updates a worker. Creates or updates a worker. @@ -3344,18 +6541,79 @@ async def upsert_worker( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterWorker. The RouterWorker is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterWorker :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } """ @overload async def upsert_worker( self, worker_id: str, - resource: IO, + resource: IO[bytes], *, content_type: str = "application/merge-patch+json", if_unmodified_since: Optional[datetime.datetime] = None, @@ -3363,6 +6621,7 @@ async def upsert_worker( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterWorker: + # pylint: disable=line-too-long """Creates or updates a worker. Creates or updates a worker. @@ -3370,7 +6629,7 @@ async def upsert_worker( :param worker_id: Id of a worker. Required. :type worker_id: str :param resource: The resource instance. Required. - :type resource: IO + :type resource: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str @@ -3382,33 +6641,95 @@ async def upsert_worker( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterWorker. The RouterWorker is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterWorker :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } """ @distributed_trace_async async def upsert_worker( self, worker_id: str, - resource: Union[_models.RouterWorker, JSON, IO], + resource: Union[_models.RouterWorker, JSON, IO[bytes]], *, if_unmodified_since: Optional[datetime.datetime] = None, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.RouterWorker: + # pylint: disable=line-too-long """Creates or updates a worker. Creates or updates a worker. :param worker_id: Id of a worker. Required. :type worker_id: str - :param resource: The resource instance. Is one of the following types: RouterWorker, JSON, IO - Required. - :type resource: ~azure.communication.jobrouter.models.RouterWorker or JSON or IO + :param resource: The resource instance. Is one of the following types: RouterWorker, JSON, + IO[bytes] Required. + :type resource: ~azure.communication.jobrouter.models.RouterWorker or JSON or IO[bytes] :keyword if_unmodified_since: The request should only proceed if the entity was not modified after this time. Default value is None. :paramtype if_unmodified_since: ~datetime.datetime @@ -3417,13 +6738,132 @@ async def upsert_worker( :paramtype etag: str :keyword match_condition: The match condition to use upon the etag. Default value is None. :paramtype match_condition: ~azure.core.MatchConditions - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterWorker. The RouterWorker is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterWorker :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } + + # response body for status code(s): 201, 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } """ error_map = { 401: ClientAuthenticationError, @@ -3507,17 +6947,79 @@ async def upsert_worker( @distributed_trace_async async def get_worker(self, worker_id: str, **kwargs: Any) -> _models.RouterWorker: + # pylint: disable=line-too-long """Retrieves an existing worker by Id. Retrieves an existing worker by Id. :param worker_id: Id of a worker. Required. :type worker_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: RouterWorker. The RouterWorker is compatible with MutableMapping :rtype: ~azure.communication.jobrouter.models.RouterWorker :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } """ error_map = { 401: ClientAuthenticationError, @@ -3633,7 +7135,8 @@ def list_workers( queue_id: Optional[str] = None, has_capacity: Optional[bool] = None, **kwargs: Any - ) -> AsyncItemPaged["_models.RouterWorker"]: + ) -> AsyncIterable["_models.RouterWorker"]: + # pylint: disable=line-too-long """Retrieves existing workers. Retrieves existing workers. @@ -3656,6 +7159,69 @@ def list_workers( :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.communication.jobrouter.models.RouterWorker] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "etag": "str", # The entity tag for this resource. Required. + "id": "str", # Id of a worker. Required. + "assignedJobs": [ + { + "assignedAt": "2020-02-20 00:00:00", # The assignment time + of the job in UTC. Required. + "assignmentId": "str", # Id of the assignment. Required. + "capacityCost": 0, # The amount of capacity this assignment + has consumed on the worker. Required. + "jobId": "str" # Id of the job assigned. Required. + } + ], + "availableForOffers": bool, # Optional. A flag indicating this worker is + open to receive offers or not. + "capacity": 0, # Optional. The total capacity score this worker has to + manage multiple concurrent jobs. + "channels": [ + { + "capacityCostPerJob": 0, # The amount of capacity that an + instance of a job of this channel will consume of the total worker + capacity. Required. + "channelId": "str", # Id of a channel. Required. + "maxNumberOfJobs": 0 # Optional. The maximum number of jobs + that can be supported concurrently for this channel. + } + ], + "labels": { + "str": {} # Optional. A set of key/value pairs that are identifying + attributes used by the rules engines to make decisions. Values must be + primitive values - number, string, boolean. + }, + "loadRatio": 0.0, # Optional. A value indicating the workers capacity. A + value of '1' means all capacity is consumed. A value of '0' means no capacity is + currently consumed. + "offers": [ + { + "capacityCost": 0, # The capacity cost consumed by the job + offer. Required. + "jobId": "str", # Id of the job. Required. + "offerId": "str", # Id of an offer. Required. + "expiresAt": "2020-02-20 00:00:00", # Optional. Timestamp + when the offer will expire in UTC. + "offeredAt": "2020-02-20 00:00:00" # Optional. Timestamp + when the offer was created in UTC. + } + ], + "queues": [ + "str" # Optional. Collection of queue(s) that this worker can + receive work from. + ], + "state": "str", # Optional. Current state of a worker. Known values are: + "active", "draining", and "inactive". + "tags": { + "str": {} # Optional. A set of non-identifying attributes attached + to this worker. Values must be primitive values - number, string, boolean. + } + } """ _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/models/_enums.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/models/_enums.py index 48213ad16d18..dfa3514a122b 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/models/_enums.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/models/_enums.py @@ -151,7 +151,7 @@ class RouterJobStatusSelector(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Job is in a suspended state and waiting for an update.""" ACTIVE = "active" """Job is in a state of PendingClassification or Queued or Assigned or ClassificationFailed or - #: Completed or PendingSchedule or Scheduled or ScheduleFailed or WaitingForActivation.""" + Completed or PendingSchedule or Scheduled or ScheduleFailed or WaitingForActivation.""" class RouterRuleKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -185,7 +185,7 @@ class RouterWorkerState(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Worker is active and available to take offers.""" DRAINING = "draining" """Worker is not active, if there are existing offers they are being revoked. No new offers are - #: sent.""" + sent.""" INACTIVE = "inactive" """Worker is not active. No new offers are sent.""" @@ -197,7 +197,7 @@ class RouterWorkerStateSelector(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Worker is active and available to take offers.""" DRAINING = "draining" """Worker is not active, if there are existing offers they are being revoked. No new offers are - #: sent.""" + sent.""" INACTIVE = "inactive" """Worker is not active. No new offers are sent.""" ALL = "all" @@ -211,7 +211,7 @@ class ScoringRuleParameterSelector(str, Enum, metaclass=CaseInsensitiveEnumMeta) """Parameter to add job labels to scoring payload. Property is sent as ``job``.""" WORKER_SELECTORS = "workerSelectors" """Parameter to add worker selectors from a job to scoring payload. Property is sent as - #: ``selectors``.""" + ``selectors``.""" class WorkerSelectorAttachmentKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/models/_models.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/models/_models.py index 68689b307e12..637f6e31d206 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/models/_models.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/models/_models.py @@ -1,5 +1,5 @@ # coding=utf-8 -# pylint: disable=too-many-lines,anomalous-backslash-in-string,name-too-long +# pylint: disable=too-many-lines # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. @@ -8,8 +8,7 @@ # -------------------------------------------------------------------------- import datetime -import sys -from typing import Any, Dict, List, Mapping, Optional, TYPE_CHECKING, Union, overload +from typing import Any, Dict, List, Literal, Mapping, Optional, TYPE_CHECKING, Union, overload from .. import _model_base from .._model_base import rest_discriminator, rest_field @@ -23,11 +22,6 @@ WorkerSelectorAttachmentKind, ) -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - if TYPE_CHECKING: # pylint: disable=unused-import,ungrouped-imports from .. import models as _models @@ -98,6 +92,7 @@ class DistributionMode(_model_base.Model): values are: "bestWorker", "longestIdle", and "roundRobin". :vartype kind: str or ~azure.communication.jobrouter.models.DistributionModeKind """ + __mapping__: Dict[str, _model_base.Model] = {} min_concurrent_offers: Optional[int] = rest_field(name="minConcurrentOffers") """Governs the minimum desired number of active concurrent offers a job can have.""" @@ -108,7 +103,7 @@ class DistributionMode(_model_base.Model): selectors. Warning: You may get workers that are not qualified for a job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false.""" - kind: Literal[None] = rest_discriminator(name="kind") + kind: str = rest_discriminator(name="kind") """The type discriminator describing a sub-type of DistributionMode. Required. Known values are: \"bestWorker\", \"longestIdle\", and \"roundRobin\".""" @@ -116,6 +111,7 @@ class DistributionMode(_model_base.Model): def __init__( self, *, + kind: str, min_concurrent_offers: Optional[int] = None, max_concurrent_offers: Optional[int] = None, bypass_selectors: Optional[bool] = None, @@ -129,9 +125,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) - self.kind: Literal[None] = None class BestWorkerMode(DistributionMode, discriminator="bestWorker"): @@ -193,9 +188,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[DistributionModeKind.BEST_WORKER] = DistributionModeKind.BEST_WORKER + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=DistributionModeKind.BEST_WORKER, **kwargs) class ExceptionAction(_model_base.Model): @@ -216,7 +210,7 @@ class ExceptionAction(_model_base.Model): __mapping__: Dict[str, _model_base.Model] = {} id: Optional[str] = rest_field() """Unique Id of the exception action.""" - kind: Literal[None] = rest_discriminator(name="kind") + kind: str = rest_discriminator(name="kind") """The type discriminator describing a sub-type of ExceptionAction. Required. Known values are: \"cancel\", \"manualReclassify\", and \"reclassify\".""" @@ -224,6 +218,7 @@ class ExceptionAction(_model_base.Model): def __init__( self, *, + kind: str, id: Optional[str] = None, # pylint: disable=redefined-builtin ): ... @@ -235,9 +230,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) - self.kind: Literal[None] = None class CancelExceptionAction(ExceptionAction, discriminator="cancel"): @@ -283,9 +277,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[ExceptionActionKind.CANCEL] = ExceptionActionKind.CANCEL + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=ExceptionActionKind.CANCEL, **kwargs) class CancelJobOptions(_model_base.Model): @@ -498,13 +491,27 @@ class QueueSelectorAttachment(_model_base.Model): """ __mapping__: Dict[str, _model_base.Model] = {} - kind: Literal[None] = rest_discriminator(name="kind") + kind: str = rest_discriminator(name="kind") """The type discriminator describing a sub-type of QueueSelectorAttachment. Required. Known values are: \"conditional\", \"passThrough\", \"ruleEngine\", \"static\", and \"weightedAllocation\".""" - def __init__(self, *args: Any, **kwargs: Any) -> None: + @overload + def __init__( + self, + *, + kind: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) - self.kind: Literal[None] = None class ConditionalQueueSelectorAttachment(QueueSelectorAttachment, discriminator="conditional"): @@ -547,9 +554,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[QueueSelectorAttachmentKind.CONDITIONAL] = QueueSelectorAttachmentKind.CONDITIONAL + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=QueueSelectorAttachmentKind.CONDITIONAL, **kwargs) class WorkerSelectorAttachment(_model_base.Model): @@ -569,14 +575,28 @@ class WorkerSelectorAttachment(_model_base.Model): """ __mapping__: Dict[str, _model_base.Model] = {} - kind: Literal[None] = rest_discriminator(name="kind") + kind: str = rest_discriminator(name="kind") """The type discriminator describing a sub-type of WorkerSelectorAttachment. Required. Known values are: \"conditional\", \"passThrough\", \"ruleEngine\", \"static\", and \"weightedAllocation\".""" - def __init__(self, *args: Any, **kwargs: Any) -> None: + @overload + def __init__( + self, + *, + kind: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) - self.kind: Literal[None] = None class ConditionalWorkerSelectorAttachment(WorkerSelectorAttachment, discriminator="conditional"): @@ -619,9 +639,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[WorkerSelectorAttachmentKind.CONDITIONAL] = WorkerSelectorAttachmentKind.CONDITIONAL + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=WorkerSelectorAttachmentKind.CONDITIONAL, **kwargs) class DeclineJobOfferOptions(_model_base.Model): @@ -686,13 +705,27 @@ class RouterRule(_model_base.Model): """ __mapping__: Dict[str, _model_base.Model] = {} - kind: Literal[None] = rest_discriminator(name="kind") + kind: str = rest_discriminator(name="kind") """The type discriminator describing a sub-type of RouterRule. Required. Known values are: \"directMap\", \"expression\", \"function\", \"static\", and \"webhook\".""" - def __init__(self, *args: Any, **kwargs: Any) -> None: + @overload + def __init__( + self, + *, + kind: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) - self.kind: Literal[None] = None class DirectMapRouterRule(RouterRule, discriminator="directMap"): @@ -709,10 +742,6 @@ class DirectMapRouterRule(RouterRule, discriminator="directMap"): """The type discriminator describing a sub-type of Rule. Required. Discriminator value for DirectMapRouterRule.""" - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[RouterRuleKind.DIRECT_MAP] = RouterRuleKind.DIRECT_MAP - class DistributionPolicy(_model_base.Model): """Policy governing how jobs are distributed to workers. @@ -867,13 +896,27 @@ class ExceptionTrigger(_model_base.Model): """ __mapping__: Dict[str, _model_base.Model] = {} - kind: Literal[None] = rest_discriminator(name="kind") + kind: str = rest_discriminator(name="kind") """The type discriminator describing a sub-type of ExceptionTrigger. Required. Known values are: \"queueLength\" and \"waitTime\".""" - def __init__(self, *args: Any, **kwargs: Any) -> None: + @overload + def __init__( + self, + *, + kind: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) - self.kind: Literal[None] = None class ExpressionRouterRule(RouterRule, discriminator="expression"): @@ -915,9 +958,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[RouterRuleKind.EXPRESSION] = RouterRuleKind.EXPRESSION + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RouterRuleKind.EXPRESSION, **kwargs) class FunctionRouterRule(RouterRule, discriminator="function"): @@ -958,9 +1000,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[RouterRuleKind.FUNCTION] = RouterRuleKind.FUNCTION + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RouterRuleKind.FUNCTION, **kwargs) class FunctionRouterRuleCredential(_model_base.Model): @@ -1025,13 +1066,27 @@ class JobMatchingMode(_model_base.Model): """ __mapping__: Dict[str, _model_base.Model] = {} - kind: Literal[None] = rest_discriminator(name="kind") + kind: str = rest_discriminator(name="kind") """The type discriminator describing a sub-type of JobMatchingMode. Required. Known values are: \"queueAndMatch\", \"scheduleAndSuspend\", and \"suspend\".""" - def __init__(self, *args: Any, **kwargs: Any) -> None: + @overload + def __init__( + self, + *, + kind: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) - self.kind: Literal[None] = None class LongestIdleMode(DistributionMode, discriminator="longestIdle"): @@ -1076,9 +1131,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[DistributionModeKind.LONGEST_IDLE] = DistributionModeKind.LONGEST_IDLE + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=DistributionModeKind.LONGEST_IDLE, **kwargs) class ManualReclassifyExceptionAction(ExceptionAction, discriminator="manualReclassify"): @@ -1128,9 +1182,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[ExceptionActionKind.MANUAL_RECLASSIFY] = ExceptionActionKind.MANUAL_RECLASSIFY + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=ExceptionActionKind.MANUAL_RECLASSIFY, **kwargs) class OAuth2WebhookClientCredential(_model_base.Model): @@ -1211,9 +1264,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[QueueSelectorAttachmentKind.PASS_THROUGH] = QueueSelectorAttachmentKind.PASS_THROUGH + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=QueueSelectorAttachmentKind.PASS_THROUGH, **kwargs) class PassThroughWorkerSelectorAttachment(WorkerSelectorAttachment, discriminator="passThrough"): @@ -1265,9 +1317,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[WorkerSelectorAttachmentKind.PASS_THROUGH] = WorkerSelectorAttachmentKind.PASS_THROUGH + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=WorkerSelectorAttachmentKind.PASS_THROUGH, **kwargs) class QueueAndMatchMode(JobMatchingMode, discriminator="queueAndMatch"): @@ -1285,10 +1336,6 @@ class QueueAndMatchMode(JobMatchingMode, discriminator="queueAndMatch"): """The type discriminator describing QueueAndMatchMode. Required. Discriminator value for QueueAndMatchMode.""" - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[JobMatchingModeKind.QUEUE_AND_MATCH] = JobMatchingModeKind.QUEUE_AND_MATCH - class QueueLengthExceptionTrigger(ExceptionTrigger, discriminator="queueLength"): """Trigger for an exception action on exceeding queue length. @@ -1324,9 +1371,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[ExceptionTriggerKind.QUEUE_LENGTH] = ExceptionTriggerKind.QUEUE_LENGTH + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=ExceptionTriggerKind.QUEUE_LENGTH, **kwargs) class QueueWeightedAllocation(_model_base.Model): @@ -1411,9 +1457,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[ExceptionActionKind.RECLASSIFY] = ExceptionActionKind.RECLASSIFY + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=ExceptionActionKind.RECLASSIFY, **kwargs) class ReclassifyJobOptions(_model_base.Model): @@ -1467,9 +1512,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[DistributionModeKind.ROUND_ROBIN] = DistributionModeKind.ROUND_ROBIN + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=DistributionModeKind.ROUND_ROBIN, **kwargs) class RouterChannel(_model_base.Model): @@ -2234,9 +2278,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[QueueSelectorAttachmentKind.RULE_ENGINE] = QueueSelectorAttachmentKind.RULE_ENGINE + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=QueueSelectorAttachmentKind.RULE_ENGINE, **kwargs) class RuleEngineWorkerSelectorAttachment(WorkerSelectorAttachment, discriminator="ruleEngine"): @@ -2272,9 +2315,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[WorkerSelectorAttachmentKind.RULE_ENGINE] = WorkerSelectorAttachmentKind.RULE_ENGINE + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=WorkerSelectorAttachmentKind.RULE_ENGINE, **kwargs) class ScheduleAndSuspendMode(JobMatchingMode, discriminator="scheduleAndSuspend"): @@ -2311,9 +2353,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[JobMatchingModeKind.SCHEDULE_AND_SUSPEND] = JobMatchingModeKind.SCHEDULE_AND_SUSPEND + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=JobMatchingModeKind.SCHEDULE_AND_SUSPEND, **kwargs) class ScoringRuleOptions(_model_base.Model): @@ -2408,9 +2449,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[QueueSelectorAttachmentKind.STATIC] = QueueSelectorAttachmentKind.STATIC + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=QueueSelectorAttachmentKind.STATIC, **kwargs) class StaticRouterRule(RouterRule, discriminator="static"): @@ -2448,9 +2488,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[RouterRuleKind.STATIC] = RouterRuleKind.STATIC + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RouterRuleKind.STATIC, **kwargs) class StaticWorkerSelectorAttachment(WorkerSelectorAttachment, discriminator="static"): @@ -2486,9 +2525,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[WorkerSelectorAttachmentKind.STATIC] = WorkerSelectorAttachmentKind.STATIC + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=WorkerSelectorAttachmentKind.STATIC, **kwargs) class SuspendMode(JobMatchingMode, discriminator="suspend"): @@ -2504,10 +2542,6 @@ class SuspendMode(JobMatchingMode, discriminator="suspend"): kind: Literal[JobMatchingModeKind.SUSPEND] = rest_discriminator(name="kind") # type: ignore """The type discriminator describing SuspendMode. Required. Discriminator value for SuspendMode.""" - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[JobMatchingModeKind.SUSPEND] = JobMatchingModeKind.SUSPEND - class UnassignJobOptions(_model_base.Model): """Request payload for unassigning a job. @@ -2608,9 +2642,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[ExceptionTriggerKind.WAIT_TIME] = ExceptionTriggerKind.WAIT_TIME + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=ExceptionTriggerKind.WAIT_TIME, **kwargs) class WebhookRouterRule(RouterRule, discriminator="webhook"): @@ -2658,12 +2691,13 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[RouterRuleKind.WEBHOOK] = RouterRuleKind.WEBHOOK + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RouterRuleKind.WEBHOOK, **kwargs) -class WeightedAllocationQueueSelectorAttachment(QueueSelectorAttachment, discriminator="weightedAllocation"): +class WeightedAllocationQueueSelectorAttachment( + QueueSelectorAttachment, discriminator="weightedAllocation" +): # pylint: disable=name-too-long """Describes multiple sets of queue selectors, of which one will be selected and attached according to a weighting. @@ -2697,14 +2731,13 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[ - QueueSelectorAttachmentKind.WEIGHTED_ALLOCATION - ] = QueueSelectorAttachmentKind.WEIGHTED_ALLOCATION + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=QueueSelectorAttachmentKind.WEIGHTED_ALLOCATION, **kwargs) -class WeightedAllocationWorkerSelectorAttachment(WorkerSelectorAttachment, discriminator="weightedAllocation"): +class WeightedAllocationWorkerSelectorAttachment( + WorkerSelectorAttachment, discriminator="weightedAllocation" +): # pylint: disable=name-too-long """Describes multiple sets of worker selectors, of which one will be selected and attached according to a weighting. @@ -2738,11 +2771,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[ - WorkerSelectorAttachmentKind.WEIGHTED_ALLOCATION - ] = WorkerSelectorAttachmentKind.WEIGHTED_ALLOCATION + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=WorkerSelectorAttachmentKind.WEIGHTED_ALLOCATION, **kwargs) class WorkerWeightedAllocation(_model_base.Model): diff --git a/sdk/communication/azure-communication-jobrouter/setup.py b/sdk/communication/azure-communication-jobrouter/setup.py index c963bd8c05ae..b72f3aa4f4b6 100644 --- a/sdk/communication/azure-communication-jobrouter/setup.py +++ b/sdk/communication/azure-communication-jobrouter/setup.py @@ -42,11 +42,11 @@ "Programming Language :: Python", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "License :: OSI Approved :: MIT License", ], zip_safe=False, @@ -64,8 +64,8 @@ }, install_requires=[ "isodate<1.0.0,>=0.6.1", - "azure-core<2.0.0,>=1.28.0", - "typing-extensions>=4.3.0; python_version<'3.8.0'", + "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", ], - python_requires=">=3.7", + python_requires=">=3.8", ) diff --git a/sdk/communication/azure-communication-jobrouter/tsp-location.yaml b/sdk/communication/azure-communication-jobrouter/tsp-location.yaml index 142c21483fcd..4daedbee9659 100644 --- a/sdk/communication/azure-communication-jobrouter/tsp-location.yaml +++ b/sdk/communication/azure-communication-jobrouter/tsp-location.yaml @@ -1,5 +1,5 @@ repo: Azure/azure-rest-api-specs -additionalDirectories: [] +commit: 70a4ccdd2be61ae5bc524250c70270b0f4f2b540 directory: specification/communication/Communication.JobRouter -commit: 2d044b8a317aff46d45080f5a797ac376955f648 +additionalDirectories: [] diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/_meta.json b/sdk/documentintelligence/azure-ai-documentintelligence/_meta.json new file mode 100644 index 000000000000..49e10cf78a8b --- /dev/null +++ b/sdk/documentintelligence/azure-ai-documentintelligence/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "70a4ccdd2be61ae5bc524250c70270b0f4f2b540", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/ai/DocumentIntelligence", + "@azure-tools/typespec-python": "0.21.0" +} \ No newline at end of file diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_model_base.py b/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_model_base.py index 73c56ed4e4cd..1ddc071517d6 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_model_base.py +++ b/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_model_base.py @@ -5,7 +5,6 @@ # license information. # -------------------------------------------------------------------------- # pylint: disable=protected-access, arguments-differ, signature-differs, broad-except -# pyright: reportGeneralTypeIssues=false import calendar import decimal @@ -16,9 +15,11 @@ import re import copy import typing -import email +import enum +import email.utils from datetime import datetime, date, time, timedelta, timezone from json import JSONEncoder +from typing_extensions import Self import isodate from azure.core.exceptions import DeserializationError from azure.core import CaseInsensitiveEnumMeta @@ -35,6 +36,7 @@ __all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") def _timedelta_as_isostr(td: timedelta) -> str: @@ -242,7 +244,7 @@ def _deserialize_date(attr: typing.Union[str, date]) -> date: # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. if isinstance(attr, date): return attr - return isodate.parse_date(attr, defaultmonth=None, defaultday=None) + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore def _deserialize_time(attr: typing.Union[str, time]) -> time: @@ -375,8 +377,12 @@ def get(self, key: str, default: typing.Any = None) -> typing.Any: except KeyError: return default - @typing.overload # type: ignore - def pop(self, key: str) -> typing.Any: # pylint: disable=no-member + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... @typing.overload @@ -397,8 +403,8 @@ def clear(self) -> None: def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: self._data.update(*args, **kwargs) - @typing.overload # type: ignore - def setdefault(self, key: str) -> typing.Any: + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... @typing.overload @@ -438,6 +444,8 @@ def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-m return _serialize_bytes(o, format) if isinstance(o, decimal.Decimal): return float(o) + if isinstance(o, enum.Enum): + return o.value try: # First try datetime.datetime return _serialize_datetime(o, format) @@ -462,7 +470,13 @@ def _get_rest_field( def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: - return _deserialize(rf._type, value) if (rf and rf._is_model) else _serialize(value, rf._format if rf else None) + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) class Model(_MyMutableMapping): @@ -498,7 +512,7 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: def copy(self) -> "Model": return Model(self.__dict__) - def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> "Model": # pylint: disable=unused-argument + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property @@ -540,7 +554,7 @@ def _deserialize(cls, data, exist_discriminators): return cls(data) discriminator = cls._get_discriminator(exist_discriminators) exist_discriminators.append(discriminator) - mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pylint: disable=no-member + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member if mapped_cls == cls: return cls(data) return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access @@ -557,9 +571,16 @@ def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing. if exclude_readonly: readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] for k, v in self.items(): - if exclude_readonly and k in readonly_props: # pyright: ignore[reportUnboundVariable] + if exclude_readonly and k in readonly_props: # pyright: ignore continue - result[k] = Model._as_dict_value(v, exclude_readonly=exclude_readonly) + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) return result @staticmethod @@ -567,7 +588,7 @@ def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: if v is None or isinstance(v, _Null): return None if isinstance(v, (list, tuple, set)): - return [Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v] + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) if isinstance(v, dict): return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v @@ -605,29 +626,22 @@ def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj return obj return _deserialize(model_deserializer, obj) - return functools.partial(_deserialize_model, annotation) + return functools.partial(_deserialize_model, annotation) # pyright: ignore except Exception: pass # is it a literal? try: - if sys.version_info >= (3, 8): - from typing import ( - Literal, - ) # pylint: disable=no-name-in-module, ungrouped-imports - else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - - if annotation.__origin__ == Literal: + if annotation.__origin__ is typing.Literal: # pyright: ignore return None except AttributeError: pass # is it optional? try: - if any(a for a in annotation.__args__ if a == type(None)): + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore if_obj_deserializer = _get_deserialize_callable_from_annotation( - next(a for a in annotation.__args__ if a != type(None)), module, rf + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore ) def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): @@ -640,7 +654,13 @@ def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Calla pass if getattr(annotation, "__origin__", None) is typing.Union: - deserializers = [_get_deserialize_callable_from_annotation(arg, module, rf) for arg in annotation.__args__] + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] def _deserialize_with_union(deserializers, obj): for deserializer in deserializers: @@ -653,8 +673,10 @@ def _deserialize_with_union(deserializers, obj): return functools.partial(_deserialize_with_union, deserializers) try: - if annotation._name == "Dict": - value_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[1], module, rf) + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) def _deserialize_dict( value_deserializer: typing.Optional[typing.Callable], @@ -671,8 +693,8 @@ def _deserialize_dict( except (AttributeError, IndexError): pass try: - if annotation._name in ["List", "Set", "Tuple", "Sequence"]: - if len(annotation.__args__) > 1: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore def _deserialize_multiple_sequence( entry_deserializers: typing.List[typing.Optional[typing.Callable]], @@ -686,10 +708,13 @@ def _deserialize_multiple_sequence( ) entry_deserializers = [ - _get_deserialize_callable_from_annotation(dt, module, rf) for dt in annotation.__args__ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore ] return functools.partial(_deserialize_multiple_sequence, entry_deserializers) - deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) def _deserialize_sequence( deserializer: typing.Optional[typing.Callable], @@ -769,6 +794,7 @@ def __init__( visibility: typing.Optional[typing.List[str]] = None, default: typing.Any = _UNSET, format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, ): self._type = type self._rest_name_input = name @@ -778,6 +804,11 @@ def __init__( self._is_model = False self._default = default self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] @property def _rest_name(self) -> str: @@ -823,8 +854,16 @@ def rest_field( visibility: typing.Optional[typing.List[str]] = None, default: typing.Any = _UNSET, format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, ) -> typing.Any: - return _RestField(name=name, type=type, visibility=visibility, default=default, format=format) + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + ) def rest_discriminator( diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_operations/_operations.py b/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_operations/_operations.py index 895f02d524ed..a8b8e894c0d8 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_operations/_operations.py +++ b/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_operations/_operations.py @@ -561,13 +561,6 @@ def begin_analyze_document( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.LROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -1342,13 +1335,6 @@ def begin_analyze_document( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.LROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -2114,13 +2100,6 @@ def begin_analyze_document( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.LROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -2884,15 +2863,6 @@ def begin_analyze_document( :keyword output_content_format: Format of the analyze result top-level content. Known values are: "text" and "markdown". Default value is None. :paramtype output_content_format: str or ~azure.ai.documentintelligence.models.ContentFormat - :keyword content_type: Input content type. Default value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.LROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -3775,13 +3745,6 @@ def begin_classify_document( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.LROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -4539,13 +4502,6 @@ def begin_classify_document( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.LROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -5294,13 +5250,6 @@ def begin_classify_document( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.LROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -6047,15 +5996,6 @@ def begin_classify_document( :keyword split: Document splitting mode. Known values are: "auto", "none", and "perPage". Default value is None. :paramtype split: str or ~azure.ai.documentintelligence.models.SplitMode - :keyword content_type: Input content type. Default value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.LROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -6914,13 +6854,6 @@ def begin_build_document_model( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7020,13 +6953,6 @@ def begin_build_document_model( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7105,13 +7031,6 @@ def begin_build_document_model( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7189,16 +7108,6 @@ def begin_build_document_model( BuildDocumentModelRequest, JSON, IO[bytes] Required. :type build_request: ~azure.ai.documentintelligence.models.BuildDocumentModelRequest or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7411,13 +7320,6 @@ def begin_compose_model( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7511,13 +7413,6 @@ def begin_compose_model( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7596,13 +7491,6 @@ def begin_compose_model( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7680,16 +7568,6 @@ def begin_compose_model( ComposeDocumentModelRequest, JSON, IO[bytes] Required. :type compose_request: ~azure.ai.documentintelligence.models.ComposeDocumentModelRequest or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7841,8 +7719,6 @@ def authorize_model_copy( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: CopyAuthorization. The CopyAuthorization is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.CopyAuthorization :raises ~azure.core.exceptions.HttpResponseError: @@ -7888,8 +7764,6 @@ def authorize_model_copy( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: CopyAuthorization. The CopyAuthorization is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.CopyAuthorization :raises ~azure.core.exceptions.HttpResponseError: @@ -7925,8 +7799,6 @@ def authorize_model_copy( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: CopyAuthorization. The CopyAuthorization is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.CopyAuthorization :raises ~azure.core.exceptions.HttpResponseError: @@ -7961,11 +7833,6 @@ def authorize_model_copy( types: AuthorizeCopyRequest, JSON, IO[bytes] Required. :type authorize_copy_request: ~azure.ai.documentintelligence.models.AuthorizeCopyRequest or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: CopyAuthorization. The CopyAuthorization is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.CopyAuthorization :raises ~azure.core.exceptions.HttpResponseError: @@ -8130,13 +7997,6 @@ def begin_copy_model_to( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -8231,13 +8091,6 @@ def begin_copy_model_to( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -8318,13 +8171,6 @@ def begin_copy_model_to( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -8404,16 +8250,6 @@ def begin_copy_model_to( CopyAuthorization, JSON, IO[bytes] Required. :type copy_to_request: ~azure.ai.documentintelligence.models.CopyAuthorization or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -8555,8 +8391,6 @@ def get_model(self, model_id: str, **kwargs: Any) -> _models.DocumentModelDetail :param model_id: Unique document model name. Required. :type model_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.DocumentModelDetails :raises ~azure.core.exceptions.HttpResponseError: @@ -8870,8 +8704,6 @@ def get_resource_info(self, **kwargs: Any) -> _models.ResourceDetails: # pylint: disable=line-too-long """Return information about the current resource. - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ResourceDetails. The ResourceDetails is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.ResourceDetails :raises ~azure.core.exceptions.HttpResponseError: @@ -8949,8 +8781,6 @@ def get_operation(self, operation_id: str, **kwargs: Any) -> _models.OperationDe :param operation_id: Operation ID. Required. :type operation_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: OperationDetails. The OperationDetails is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.OperationDetails :raises ~azure.core.exceptions.HttpResponseError: @@ -9867,13 +9697,6 @@ def begin_build_classifier( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping :rtype: @@ -9950,13 +9773,6 @@ def begin_build_classifier( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping :rtype: @@ -10009,13 +9825,6 @@ def begin_build_classifier( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping :rtype: @@ -10067,16 +9876,6 @@ def begin_build_classifier( BuildDocumentClassifierRequest, JSON, IO[bytes] Required. :type build_request: ~azure.ai.documentintelligence.models.BuildDocumentClassifierRequest or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of LROPoller that returns DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping :rtype: @@ -10201,8 +10000,6 @@ def get_classifier(self, classifier_id: str, **kwargs: Any) -> _models.DocumentC :param classifier_id: Unique document classifier name. Required. :type classifier_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.DocumentClassifierDetails diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_serialization.py b/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_serialization.py index baa661cb82d2..2f781d740827 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_serialization.py +++ b/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_serialization.py @@ -170,13 +170,6 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], return None -try: - basestring # type: ignore - unicode_str = unicode # type: ignore -except NameError: - basestring = str - unicode_str = str - _LOGGER = logging.getLogger(__name__) try: @@ -545,7 +538,7 @@ class Serializer(object): "multiple": lambda x, y: x % y != 0, } - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.serialize_type = { "iso-8601": Serializer.serialize_iso, "rfc-1123": Serializer.serialize_rfc, @@ -561,7 +554,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "[]": self.serialize_iter, "{}": self.serialize_dict, } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: Dict[str, type] = dict(classes) if classes else {} self.key_transformer = full_restapi_key_transformer self.client_side_validation = True @@ -649,7 +642,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): else: # That's a basic type # Integrate namespace if necessary local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) - local_node.text = unicode_str(new_attr) + local_node.text = str(new_attr) serialized.append(local_node) # type: ignore else: # JSON for k in reversed(keys): # type: ignore @@ -994,7 +987,7 @@ def serialize_object(self, attr, **kwargs): return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) if obj_type is _long_type: return self.serialize_long(attr) - if obj_type is unicode_str: + if obj_type is str: return self.serialize_unicode(attr) if obj_type is datetime.datetime: return self.serialize_iso(attr) @@ -1370,7 +1363,7 @@ class Deserializer(object): valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.deserialize_type = { "iso-8601": Deserializer.deserialize_iso, "rfc-1123": Deserializer.deserialize_rfc, @@ -1390,7 +1383,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "duration": (isodate.Duration, datetime.timedelta), "iso-8601": (datetime.datetime), } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: Dict[str, type] = dict(classes) if classes else {} self.key_extractors = [rest_key_extractor, xml_key_extractor] # Additional properties only works if the "rest_key_extractor" is used to # extract the keys. Making it to work whatever the key extractor is too much @@ -1443,7 +1436,7 @@ def _deserialize(self, target_obj, data): response, class_name = self._classify_target(target_obj, data) - if isinstance(response, basestring): + if isinstance(response, str): return self.deserialize_data(data, response) elif isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) @@ -1514,14 +1507,14 @@ def _classify_target(self, target, data): if target is None: return None, None - if isinstance(target, basestring): + if isinstance(target, str): try: target = self.dependencies[target] except KeyError: return target, target try: - target = target._classify(data, self.dependencies) + target = target._classify(data, self.dependencies) # type: ignore except AttributeError: pass # Target is not a Model, no classify return target, target.__class__.__name__ # type: ignore @@ -1577,7 +1570,7 @@ def _unpack_content(raw_data, content_type=None): if hasattr(raw_data, "_content_consumed"): return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) - if isinstance(raw_data, (basestring, bytes)) or hasattr(raw_data, "read"): + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore return raw_data @@ -1699,7 +1692,7 @@ def deserialize_object(self, attr, **kwargs): if isinstance(attr, ET.Element): # Do no recurse on XML, just return the tree as-is return attr - if isinstance(attr, basestring): + if isinstance(attr, str): return self.deserialize_basic(attr, "str") obj_type = type(attr) if obj_type in self.basic_types: @@ -1756,7 +1749,7 @@ def deserialize_basic(self, attr, data_type): if data_type == "bool": if attr in [True, False, 1, 0]: return bool(attr) - elif isinstance(attr, basestring): + elif isinstance(attr, str): if attr.lower() in ["true", "1"]: return True elif attr.lower() in ["false", "0"]: diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/aio/_operations/_operations.py b/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/aio/_operations/_operations.py index b34a17f859ad..6d0e506cdc5b 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/aio/_operations/_operations.py +++ b/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/aio/_operations/_operations.py @@ -181,13 +181,6 @@ async def begin_analyze_document( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.AsyncLROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -962,13 +955,6 @@ async def begin_analyze_document( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.AsyncLROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -1734,13 +1720,6 @@ async def begin_analyze_document( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.AsyncLROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -2504,15 +2483,6 @@ async def begin_analyze_document( :keyword output_content_format: Format of the analyze result top-level content. Known values are: "text" and "markdown". Default value is None. :paramtype output_content_format: str or ~azure.ai.documentintelligence.models.ContentFormat - :keyword content_type: Input content type. Default value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.AsyncLROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -3396,13 +3366,6 @@ async def begin_classify_document( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.AsyncLROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -4160,13 +4123,6 @@ async def begin_classify_document( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.AsyncLROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -4915,13 +4871,6 @@ async def begin_classify_document( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.AsyncLROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -5668,15 +5617,6 @@ async def begin_classify_document( :keyword split: Document splitting mode. Known values are: "auto", "none", and "perPage". Default value is None. :paramtype split: str or ~azure.ai.documentintelligence.models.SplitMode - :keyword content_type: Input content type. Default value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping :rtype: ~azure.core.polling.AsyncLROPoller[~azure.ai.documentintelligence.models.AnalyzeResult] @@ -6536,13 +6476,6 @@ async def begin_build_document_model( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -6642,13 +6575,6 @@ async def begin_build_document_model( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -6727,13 +6653,6 @@ async def begin_build_document_model( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -6811,16 +6730,6 @@ async def begin_build_document_model( BuildDocumentModelRequest, JSON, IO[bytes] Required. :type build_request: ~azure.ai.documentintelligence.models.BuildDocumentModelRequest or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7034,13 +6943,6 @@ async def begin_compose_model( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7134,13 +7036,6 @@ async def begin_compose_model( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7219,13 +7114,6 @@ async def begin_compose_model( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7303,16 +7191,6 @@ async def begin_compose_model( ComposeDocumentModelRequest, JSON, IO[bytes] Required. :type compose_request: ~azure.ai.documentintelligence.models.ComposeDocumentModelRequest or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7465,8 +7343,6 @@ async def authorize_model_copy( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: CopyAuthorization. The CopyAuthorization is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.CopyAuthorization :raises ~azure.core.exceptions.HttpResponseError: @@ -7512,8 +7388,6 @@ async def authorize_model_copy( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: CopyAuthorization. The CopyAuthorization is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.CopyAuthorization :raises ~azure.core.exceptions.HttpResponseError: @@ -7549,8 +7423,6 @@ async def authorize_model_copy( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: CopyAuthorization. The CopyAuthorization is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.CopyAuthorization :raises ~azure.core.exceptions.HttpResponseError: @@ -7585,11 +7457,6 @@ async def authorize_model_copy( types: AuthorizeCopyRequest, JSON, IO[bytes] Required. :type authorize_copy_request: ~azure.ai.documentintelligence.models.AuthorizeCopyRequest or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: CopyAuthorization. The CopyAuthorization is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.CopyAuthorization :raises ~azure.core.exceptions.HttpResponseError: @@ -7754,13 +7621,6 @@ async def begin_copy_model_to( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7855,13 +7715,6 @@ async def begin_copy_model_to( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -7942,13 +7795,6 @@ async def begin_copy_model_to( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -8028,16 +7874,6 @@ async def begin_copy_model_to( CopyAuthorization, JSON, IO[bytes] Required. :type copy_to_request: ~azure.ai.documentintelligence.models.CopyAuthorization or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: @@ -8180,8 +8016,6 @@ async def get_model(self, model_id: str, **kwargs: Any) -> _models.DocumentModel :param model_id: Unique document model name. Required. :type model_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.DocumentModelDetails :raises ~azure.core.exceptions.HttpResponseError: @@ -8497,8 +8331,6 @@ async def get_resource_info(self, **kwargs: Any) -> _models.ResourceDetails: # pylint: disable=line-too-long """Return information about the current resource. - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: ResourceDetails. The ResourceDetails is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.ResourceDetails :raises ~azure.core.exceptions.HttpResponseError: @@ -8576,8 +8408,6 @@ async def get_operation(self, operation_id: str, **kwargs: Any) -> _models.Opera :param operation_id: Operation ID. Required. :type operation_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: OperationDetails. The OperationDetails is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.OperationDetails :raises ~azure.core.exceptions.HttpResponseError: @@ -9495,13 +9325,6 @@ async def begin_build_classifier( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping :rtype: @@ -9578,13 +9401,6 @@ async def begin_build_classifier( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping :rtype: @@ -9637,13 +9453,6 @@ async def begin_build_classifier( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping :rtype: @@ -9695,16 +9504,6 @@ async def begin_build_classifier( BuildDocumentClassifierRequest, JSON, IO[bytes] Required. :type build_request: ~azure.ai.documentintelligence.models.BuildDocumentClassifierRequest or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. :return: An instance of AsyncLROPoller that returns DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping :rtype: @@ -9830,8 +9629,6 @@ async def get_classifier(self, classifier_id: str, **kwargs: Any) -> _models.Doc :param classifier_id: Unique document classifier name. Required. :type classifier_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping :rtype: ~azure.ai.documentintelligence.models.DocumentClassifierDetails diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/models/_enums.py b/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/models/_enums.py index 7bc9af848cec..3e918567f83f 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/models/_enums.py +++ b/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/models/_enums.py @@ -17,7 +17,7 @@ class ContentFormat(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Plain text representation of the document content without any formatting.""" MARKDOWN = "markdown" """Markdown representation of the document content with section headings, tables, - #: etc.""" + etc.""" class ContentSourceKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -147,7 +147,7 @@ class DocumentSelectionMarkState(str, Enum, metaclass=CaseInsensitiveEnumMeta): SELECTED = "selected" """The selection mark is selected, often indicated by a check ✓ or cross X inside - #: the selection mark.""" + the selection mark.""" UNSELECTED = "unselected" """The selection mark is not selected.""" @@ -214,7 +214,7 @@ class OperationKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Compose a new custom document model from existing models.""" DOCUMENT_MODEL_COPY_TO = "documentModelCopyTo" """Copy an existing document model to potentially a different resource, region, or - #: subscription.""" + subscription.""" DOCUMENT_CLASSIFIER_BUILD = "documentClassifierBuild" """Build a new custom classifier model.""" @@ -269,9 +269,9 @@ class StringIndexType(str, Enum, metaclass=CaseInsensitiveEnumMeta): TEXT_ELEMENTS = "textElements" """User-perceived display character, or grapheme cluster, as defined by Unicode - #: 8.0.0.""" + 8.0.0.""" UNICODE_CODE_POINT = "unicodeCodePoint" """Character unit represented by a single unicode code point. Used by Python 3.""" UTF16_CODE_UNIT = "utf16CodeUnit" """Character unit represented by a 16-bit Unicode code unit. Used by JavaScript, - #: Java, and .NET.""" + Java, and .NET.""" diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/models/_models.py b/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/models/_models.py index ccdbb01a65db..34b273453376 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/models/_models.py +++ b/sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/models/_models.py @@ -8,18 +8,12 @@ # -------------------------------------------------------------------------- import datetime -import sys -from typing import Any, Dict, List, Mapping, Optional, TYPE_CHECKING, Union, overload +from typing import Any, Dict, List, Literal, Mapping, Optional, TYPE_CHECKING, Union, overload from .. import _model_base from .._model_base import rest_discriminator, rest_field from ._enums import OperationKind -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - if TYPE_CHECKING: # pylint: disable=unused-import,ungrouped-imports from .. import models as _models @@ -1041,7 +1035,7 @@ class OperationDetails(_model_base.Model): """Date and time (UTC) when the operation was created. Required.""" last_updated_date_time: datetime.datetime = rest_field(name="lastUpdatedDateTime", format="rfc3339") """Date and time (UTC) when the status was last updated. Required.""" - kind: Literal[None] = rest_discriminator(name="kind") + kind: str = rest_discriminator(name="kind") """Type of operation. Required. Known values are: \"documentModelBuild\", \"documentModelCompose\", \"documentModelCopyTo\", and \"documentClassifierBuild\".""" resource_location: str = rest_field(name="resourceLocation") @@ -1061,6 +1055,7 @@ def __init__( status: Union[str, "_models.OperationStatus"], created_date_time: datetime.datetime, last_updated_date_time: datetime.datetime, + kind: str, resource_location: str, percent_completed: Optional[int] = None, api_version: Optional[str] = None, @@ -1076,9 +1071,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) - self.kind: Literal[None] = None class DocumentClassifierBuildOperationDetails( @@ -1142,9 +1136,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[OperationKind.DOCUMENT_CLASSIFIER_BUILD] = OperationKind.DOCUMENT_CLASSIFIER_BUILD + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=OperationKind.DOCUMENT_CLASSIFIER_BUILD, **kwargs) class DocumentClassifierDetails(_model_base.Model): @@ -1868,9 +1861,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[OperationKind.DOCUMENT_MODEL_BUILD] = OperationKind.DOCUMENT_MODEL_BUILD + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=OperationKind.DOCUMENT_MODEL_BUILD, **kwargs) class DocumentModelComposeOperationDetails( @@ -1935,9 +1927,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[OperationKind.DOCUMENT_MODEL_COMPOSE] = OperationKind.DOCUMENT_MODEL_COMPOSE + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=OperationKind.DOCUMENT_MODEL_COMPOSE, **kwargs) class DocumentModelCopyToOperationDetails( @@ -2005,9 +1996,8 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - self.kind: Literal[OperationKind.DOCUMENT_MODEL_COPY_TO] = OperationKind.DOCUMENT_MODEL_COPY_TO + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=OperationKind.DOCUMENT_MODEL_COPY_TO, **kwargs) class DocumentModelDetails(_model_base.Model): diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/sdk_packaging.toml b/sdk/documentintelligence/azure-ai-documentintelligence/sdk_packaging.toml new file mode 100644 index 000000000000..e7687fdae93b --- /dev/null +++ b/sdk/documentintelligence/azure-ai-documentintelligence/sdk_packaging.toml @@ -0,0 +1,2 @@ +[packaging] +auto_update = false \ No newline at end of file diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/setup.py b/sdk/documentintelligence/azure-ai-documentintelligence/setup.py index db604bbb17b1..eb407430518b 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/setup.py +++ b/sdk/documentintelligence/azure-ai-documentintelligence/setup.py @@ -64,8 +64,8 @@ }, install_requires=[ "isodate<1.0.0,>=0.6.1", - "azure-core<2.0.0,>=1.29.5", - "typing-extensions>=4.3.0; python_version<'3.8.0'", + "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", ], python_requires=">=3.8", ) diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/tsp-location.yaml b/sdk/documentintelligence/azure-ai-documentintelligence/tsp-location.yaml index 391e552952ae..0ecef091a442 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/tsp-location.yaml +++ b/sdk/documentintelligence/azure-ai-documentintelligence/tsp-location.yaml @@ -1,5 +1,5 @@ +commit: 70a4ccdd2be61ae5bc524250c70270b0f4f2b540 directory: specification/ai/DocumentIntelligence -commit: 9156bd5b8ca713e9c1c7d5c2ce4621e51491ccac additionalDirectories: [] repo: Azure/azure-rest-api-specs diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/_meta.json b/sdk/healthinsights/azure-healthinsights-cancerprofiling/_meta.json new file mode 100644 index 000000000000..46d0632db4b5 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "70a4ccdd2be61ae5bc524250c70270b0f4f2b540", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/ai/HealthInsights/HealthInsights.OncoPhenotype", + "@azure-tools/typespec-python": "0.21.0" +} \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_client.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_client.py index 4ac3aa0699a5..557fd9f0442e 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_client.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_client.py @@ -11,6 +11,7 @@ from azure.core import PipelineClient from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies from azure.core.rest import HttpRequest, HttpResponse from ._configuration import CancerProfilingClientConfiguration @@ -18,9 +19,7 @@ from ._serialization import Deserializer, Serializer -class CancerProfilingClient( - CancerProfilingClientOperationsMixin -): # pylint: disable=client-accepts-api-version-keyword +class CancerProfilingClient(CancerProfilingClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword """CancerProfilingClient. :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: @@ -29,7 +28,7 @@ class CancerProfilingClient( :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str :keyword int polling_interval: Default waiting time between two polls for LRO operations if no @@ -37,15 +36,32 @@ class CancerProfilingClient( """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - _endpoint = "{endpoint}/healthinsights" + _endpoint = "{endpoint}/health-insights" self._config = CancerProfilingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - self._client: PipelineClient = PipelineClient(base_url=_endpoint, config=self._config, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) self._serialize = Serializer() self._deserialize = Deserializer() self._serialize.client_side_validation = False - def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -69,7 +85,7 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore def close(self) -> None: self._client.close() diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_configuration.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_configuration.py index 81364c5be4f2..c69488a35ec7 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_configuration.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_configuration.py @@ -6,22 +6,15 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import sys from typing import Any -from azure.core.configuration import Configuration from azure.core.credentials import AzureKeyCredential from azure.core.pipeline import policies from ._version import VERSION -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - -class CancerProfilingClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes +class CancerProfilingClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long """Configuration for CancerProfilingClient. Note that all parameters used to create this instance are saved as instance @@ -33,14 +26,13 @@ class CancerProfilingClientConfiguration(Configuration): # pylint: disable=too- :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - super(CancerProfilingClientConfiguration, self).__init__(**kwargs) - api_version: Literal["2023-03-01-preview"] = kwargs.pop("api_version", "2023-03-01-preview") + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -51,6 +43,7 @@ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) self.credential = credential self.api_version = api_version kwargs.setdefault("sdk_moniker", "healthinsights-cancerprofiling/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -59,9 +52,9 @@ def _configure(self, **kwargs: Any) -> None: self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) - self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) self.authentication_policy = kwargs.get("authentication_policy") if self.credential and not self.authentication_policy: self.authentication_policy = policies.AzureKeyCredentialPolicy( diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_model_base.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_model_base.py index c6fcd9a18c25..1ddc071517d6 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_model_base.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_model_base.py @@ -5,8 +5,9 @@ # license information. # -------------------------------------------------------------------------- # pylint: disable=protected-access, arguments-differ, signature-differs, broad-except -# pyright: reportGeneralTypeIssues=false +import calendar +import decimal import functools import sys import logging @@ -14,13 +15,16 @@ import re import copy import typing +import enum +import email.utils from datetime import datetime, date, time, timedelta, timezone from json import JSONEncoder +from typing_extensions import Self import isodate from azure.core.exceptions import DeserializationError from azure.core import CaseInsensitiveEnumMeta from azure.core.pipeline import PipelineResponse -from azure.core.serialization import NULL as AzureCoreNull +from azure.core.serialization import _Null if sys.version_info >= (3, 9): from collections.abc import MutableMapping @@ -29,25 +33,10 @@ _LOGGER = logging.getLogger(__name__) -__all__ = ["NULL", "AzureJSONEncoder", "Model", "rest_field", "rest_discriminator"] - - -class _Null(object): - """To create a Falsy object""" - - def __bool__(self): - return False - - __nonzero__ = __bool__ # Python2 compatibility - - -NULL = _Null() -""" -A falsy sentinel object which is supposed to be used to specify attributes -with no data. This gets serialized to `null` on the wire. -""" +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") def _timedelta_as_isostr(td: timedelta) -> str: @@ -74,69 +63,53 @@ def _timedelta_as_isostr(td: timedelta) -> str: if days: date_str = "%sD" % days - # Build time - time_str = "T" + if hours or minutes or seconds: + # Build time + time_str = "T" - # Hours - bigger_exists = date_str or hours - if bigger_exists: - time_str += "{:02}H".format(hours) + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) - # Minutes - bigger_exists = bigger_exists or minutes - if bigger_exists: - time_str += "{:02}M".format(minutes) + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) - # Seconds - try: - if seconds.is_integer(): - seconds_string = "{:02}".format(int(seconds)) - else: - # 9 chars long w/ leading 0, 6 digits after decimal - seconds_string = "%09.6f" % seconds - # Remove trailing zeros - seconds_string = seconds_string.rstrip("0") - except AttributeError: # int.is_integer() raises - seconds_string = "{:02}".format(seconds) + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) - time_str += "{}S".format(seconds_string) + time_str += "{}S".format(seconds_string) + else: + time_str = "" return "P" + date_str + time_str -def _datetime_as_isostr(dt: typing.Union[datetime, date, time, timedelta]) -> str: - """Converts a datetime.(datetime|date|time|timedelta) object into an ISO 8601 formatted string - - :param timedelta dt: The date object to convert - :rtype: str - :return: ISO8601 version of this datetime - """ - # First try datetime.datetime - if hasattr(dt, "year") and hasattr(dt, "hour"): - dt = typing.cast(datetime, dt) - # astimezone() fails for naive times in Python 2.7, so make make sure dt is aware (tzinfo is set) - if not dt.tzinfo: - iso_formatted = dt.replace(tzinfo=TZ_UTC).isoformat() - else: - iso_formatted = dt.astimezone(TZ_UTC).isoformat() - # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) - return iso_formatted.replace("+00:00", "Z") - # Next try datetime.date or datetime.time - try: - dt = typing.cast(typing.Union[date, time], dt) - return dt.isoformat() - # Last, try datetime.timedelta - except AttributeError: - dt = typing.cast(timedelta, dt) - return _timedelta_as_isostr(dt) - - -def _serialize_bytes(o) -> str: - return base64.b64encode(o).decode() +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded -def _serialize_datetime(o): +def _serialize_datetime(o, format: typing.Optional[str] = None): if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) if not o.tzinfo: iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() @@ -150,32 +123,37 @@ def _serialize_datetime(o): def _is_readonly(p): try: - return p._readonly # pylint: disable=protected-access + return p._visibility == ["read"] # pylint: disable=protected-access except AttributeError: return False -class AzureJSONEncoder(JSONEncoder): +class SdkJSONEncoder(JSONEncoder): """A JSON encoder that's capable of serializing datetime objects and bytes.""" + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + def default(self, o): # pylint: disable=too-many-return-statements if _is_model(o): - readonly_props = [ - p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p) - ] # pylint: disable=protected-access - return {k: v for k, v in o.items() if k not in readonly_props} - if isinstance(o, (bytes, bytearray)): - return base64.b64encode(o).decode() - if o is AzureCoreNull: - return None + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) try: - return super(AzureJSONEncoder, self).default(o) + return super(SdkJSONEncoder, self).default(o) except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) if isinstance(o, (bytes, bytearray)): - return _serialize_bytes(o) + return _serialize_bytes(o, self.format) try: # First try datetime.datetime - return _serialize_datetime(o) + return _serialize_datetime(o, self.format) except AttributeError: pass # Last, try datetime.timedelta @@ -184,10 +162,14 @@ def default(self, o): # pylint: disable=too-many-return-statements except AttributeError: # This will be raised when it hits value.total_seconds in the method above pass - return super(AzureJSONEncoder, self).default(o) + return super(SdkJSONEncoder, self).default(o) _VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: @@ -223,6 +205,36 @@ def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: return date_obj +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + def _deserialize_date(attr: typing.Union[str, date]) -> date: """Deserialize ISO-8601 formatted string into Date object. :param str attr: response string to be deserialized. @@ -232,7 +244,7 @@ def _deserialize_date(attr: typing.Union[str, date]) -> date: # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. if isinstance(attr, date): return attr - return isodate.parse_date(attr, defaultmonth=None, defaultday=None) + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore def _deserialize_time(attr: typing.Union[str, time]) -> time: @@ -247,33 +259,74 @@ def _deserialize_time(attr: typing.Union[str, time]) -> time: return isodate.parse_time(attr) -def deserialize_bytes(attr): +def _deserialize_bytes(attr): if isinstance(attr, (bytes, bytearray)): return attr return bytes(base64.b64decode(attr)) -def deserialize_duration(attr): +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): if isinstance(attr, timedelta): return attr return isodate.parse_duration(attr) +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + _DESERIALIZE_MAPPING = { datetime: _deserialize_datetime, date: _deserialize_date, time: _deserialize_time, - bytes: deserialize_bytes, - timedelta: deserialize_duration, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, } +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + def _get_model(module_name: str, model_name: str): models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} module_end = module_name.rsplit(".", 1)[0] - module = sys.modules[module_end] - models.update({k: v for k, v in module.__dict__.items() if isinstance(v, type)}) + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) if isinstance(model_name, str): model_name = model_name.split(".")[-1] if model_name not in models: @@ -324,8 +377,12 @@ def get(self, key: str, default: typing.Any = None) -> typing.Any: except KeyError: return default - @typing.overload # type: ignore - def pop(self, key: str) -> typing.Any: # pylint: disable=no-member + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... @typing.overload @@ -346,8 +403,8 @@ def clear(self) -> None: def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: self._data.update(*args, **kwargs) - @typing.overload # type: ignore - def setdefault(self, key: str) -> typing.Any: + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... @typing.overload @@ -374,12 +431,24 @@ def _is_model(obj: typing.Any) -> bool: return getattr(obj, "_is_model", False) -def _serialize(o): +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) if isinstance(o, (bytes, bytearray)): - return _serialize_bytes(o) + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value try: # First try datetime.datetime - return _serialize_datetime(o) + return _serialize_datetime(o, format) except AttributeError: pass # Last, try datetime.timedelta @@ -401,7 +470,13 @@ def _get_rest_field( def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: - return _deserialize(rf._type, value) if (rf and rf._is_model) else _serialize(value) + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) class Model(_MyMutableMapping): @@ -425,13 +500,19 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: if non_attr_kwargs: # actual type errors only throw the first wrong keyword arg they see, so following that. raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") - dict_to_pass.update({self._attr_to_rest_field[k]._rest_name: _serialize(v) for k, v in kwargs.items()}) + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) super().__init__(dict_to_pass) def copy(self) -> "Model": return Model(self.__dict__) - def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> "Model": # pylint: disable=unused-argument + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property @@ -459,31 +540,84 @@ def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member @classmethod - def _get_discriminator(cls) -> typing.Optional[str]: + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: for v in cls.__dict__.values(): - if isinstance(v, _RestField) and v._is_discriminator: # pylint: disable=protected-access + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access return v._rest_name # pylint: disable=protected-access return None @classmethod - def _deserialize(cls, data): + def _deserialize(cls, data, exist_discriminators): if not hasattr(cls, "__mapping__"): # pylint: disable=no-member return cls(data) - discriminator = cls._get_discriminator() - mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pylint: disable=no-member + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member if mapped_cls == cls: return cls(data) - return mapped_cls._deserialize(data) # pylint: disable=protected-access + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v -def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-statements - annotation: typing.Any, module: typing.Optional[str], rf: typing.Optional["_RestField"] = None +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: if not annotation or annotation in [int, float]: return None + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + try: - if module and _is_model(_get_model(module, annotation)): + if module and _is_model(annotation): if rf: rf._is_model = True @@ -492,42 +626,22 @@ def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj return obj return _deserialize(model_deserializer, obj) - return functools.partial(_deserialize_model, _get_model(module, annotation)) + return functools.partial(_deserialize_model, annotation) # pyright: ignore except Exception: pass # is it a literal? try: - if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports - else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - - if annotation.__origin__ == Literal: + if annotation.__origin__ is typing.Literal: # pyright: ignore return None except AttributeError: pass - if getattr(annotation, "__origin__", None) is typing.Union: - - def _deserialize_with_union(union_annotation, obj): - for t in union_annotation.__args__: - try: - return _deserialize(t, obj, module) - except DeserializationError: - pass - raise DeserializationError() - - return functools.partial(_deserialize_with_union, annotation) - # is it optional? try: - # right now, assuming we don't have unions, since we're getting rid of the only - # union we used to have in msrest models, which was union of str and enum - if any(a for a in annotation.__args__ if a == type(None)): - + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore if_obj_deserializer = _get_deserialize_callable_from_annotation( - next(a for a in annotation.__args__ if a != type(None)), module, rf + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore ) def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): @@ -539,45 +653,52 @@ def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Calla except AttributeError: pass - # is it a forward ref / in quotes? - if isinstance(annotation, (str, typing.ForwardRef)): - try: - model_name = annotation.__forward_arg__ # type: ignore - except AttributeError: - model_name = annotation - if module is not None: - annotation = _get_model(module, model_name) + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) try: - if annotation._name == "Dict": - key_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) - value_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[1], module, rf) + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) def _deserialize_dict( - key_deserializer: typing.Optional[typing.Callable], value_deserializer: typing.Optional[typing.Callable], obj: typing.Dict[typing.Any, typing.Any], ): if obj is None: return obj - return { - _deserialize(key_deserializer, k, module): _deserialize(value_deserializer, v, module) - for k, v in obj.items() - } + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} return functools.partial( _deserialize_dict, - key_deserializer, value_deserializer, ) except (AttributeError, IndexError): pass try: - if annotation._name in ["List", "Set", "Tuple", "Sequence"]: - if len(annotation.__args__) > 1: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore def _deserialize_multiple_sequence( - entry_deserializers: typing.List[typing.Optional[typing.Callable]], obj + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, ): if obj is None: return obj @@ -587,10 +708,13 @@ def _deserialize_multiple_sequence( ) entry_deserializers = [ - _get_deserialize_callable_from_annotation(dt, module, rf) for dt in annotation.__args__ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore ] return functools.partial(_deserialize_multiple_sequence, entry_deserializers) - deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) def _deserialize_sequence( deserializer: typing.Optional[typing.Callable], @@ -605,26 +729,29 @@ def _deserialize_sequence( pass def _deserialize_default( - annotation, - deserializer_from_mapping, + deserializer, obj, ): if obj is None: return obj try: - return _deserialize_with_callable(annotation, obj) + return _deserialize_with_callable(deserializer, obj) except Exception: pass - return _deserialize_with_callable(deserializer_from_mapping, obj) + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) - return functools.partial(_deserialize_default, annotation, _DESERIALIZE_MAPPING.get(annotation)) + return functools.partial(_deserialize_default, annotation) def _deserialize_with_callable( - deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], value: typing.Any + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, ): try: - if value is None: + if value is None or isinstance(value, _Null): return None if deserializer is None: return value @@ -635,16 +762,25 @@ def _deserialize_with_callable( # for unknown value, return raw value return value if isinstance(deserializer, type) and issubclass(deserializer, Model): - return deserializer._deserialize(value) # type: ignore + return deserializer._deserialize(value, []) return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) except Exception as e: raise DeserializationError() from e -def _deserialize(deserializer: typing.Any, value: typing.Any, module: typing.Optional[str] = None) -> typing.Any: +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: if isinstance(value, PipelineResponse): value = value.http_response.json() - deserializer = _get_deserialize_callable_from_annotation(deserializer, module) + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) return _deserialize_with_callable(deserializer, value) @@ -655,16 +791,24 @@ def __init__( name: typing.Optional[str] = None, type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin is_discriminator: bool = False, - readonly: bool = False, + visibility: typing.Optional[typing.List[str]] = None, default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, ): self._type = type self._rest_name_input = name self._module: typing.Optional[str] = None self._is_discriminator = is_discriminator - self._readonly = readonly + self._visibility = visibility self._is_model = False self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] @property def _rest_name(self) -> str: @@ -678,7 +822,9 @@ def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin item = obj.get(self._rest_name) if item is None: return item - return _deserialize(self._type, _serialize(item)) + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) def __set__(self, obj: Model, value) -> None: if value is None: @@ -688,11 +834,14 @@ def __set__(self, obj: Model, value) -> None: except KeyError: pass return - if self._is_model and not _is_model(value): - obj.__setitem__(self._rest_name, _deserialize(self._type, value)) - obj.__setitem__(self._rest_name, _serialize(value)) + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) - def _get_deserialize_callable_from_annotation( # pylint: disable=redefined-builtin + def _get_deserialize_callable_from_annotation( self, annotation: typing.Any ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: return _get_deserialize_callable_from_annotation(annotation, self._module, self) @@ -702,13 +851,24 @@ def rest_field( *, name: typing.Optional[str] = None, type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin - readonly: bool = False, + visibility: typing.Optional[typing.List[str]] = None, default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, ) -> typing.Any: - return _RestField(name=name, type=type, readonly=readonly, default=default) + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + ) def rest_discriminator( - *, name: typing.Optional[str] = None, type: typing.Optional[typing.Callable] = None # pylint: disable=redefined-builtin + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin ) -> typing.Any: return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_operations/_operations.py index 7074943fed20..ba36c5d76830 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_operations/_operations.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_operations/_operations.py @@ -1,4 +1,4 @@ -# pylint: disable=too-many-lines +# pylint: disable=too-many-lines,too-many-statements # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -7,9 +7,11 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- import datetime +from io import IOBase import json import sys from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload +import uuid from azure.core.exceptions import ( ClientAuthenticationError, @@ -20,15 +22,14 @@ map_error, ) from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import HttpResponse from azure.core.polling import LROPoller, NoPolling, PollingMethod from azure.core.polling.base_polling import LROBasePolling -from azure.core.rest import HttpRequest +from azure.core.rest import HttpRequest, HttpResponse from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict from .. import models as _models -from .._model_base import AzureJSONEncoder, _deserialize +from .._model_base import SdkJSONEncoder, _deserialize from .._serialization import Serializer from .._vendor import CancerProfilingClientMixinABC @@ -36,10 +37,6 @@ from collections.abc import MutableMapping else: from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] @@ -48,35 +45,26 @@ _SERIALIZER.client_side_validation = False -def build_cancer_profiling_infer_cancer_profile_request( # pylint: disable=name-too-long - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any -) -> HttpRequest: +def build_cancer_profiling_infer_cancer_profile_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: Literal["2023-03-01-preview"] = kwargs.pop( - "api_version", _params.pop("api-version", "2023-03-01-preview") - ) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL - _url = "/oncophenotype/jobs" + _url = "/onco-phenotype/jobs" # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers - if repeatability_request_id is not None: - _headers["Repeatability-Request-ID"] = _SERIALIZER.header( - "repeatability_request_id", repeatability_request_id, "str" - ) - if repeatability_first_sent is not None: - _headers["Repeatability-First-Sent"] = _SERIALIZER.header( - "repeatability_first_sent", repeatability_first_sent, "iso-8601" + if "Repeatability-Request-ID" not in _headers: + _headers["Repeatability-Request-ID"] = str(uuid.uuid4()) + if "Repeatability-First-Sent" not in _headers: + _headers["Repeatability-First-Sent"] = _SERIALIZER.serialize_data( + datetime.datetime.now(datetime.timezone.utc), "rfc-1123" ) _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") if content_type is not None: @@ -87,13 +75,8 @@ def build_cancer_profiling_infer_cancer_profile_request( # pylint: disable=name class CancerProfilingClientOperationsMixin(CancerProfilingClientMixinABC): def _infer_cancer_profile_initial( - self, - body: Union[_models.OncoPhenotypeData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> Optional[_models.OncoPhenotypeResult]: + self, body: Union[_models.OncoPhenotypeData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: error_map = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, @@ -106,18 +89,16 @@ def _infer_cancer_profile_initial( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[Optional[_models.OncoPhenotypeResult]] = kwargs.pop("cls", None) + cls: ClsType[JSON] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None - if isinstance(body, (IO, bytes)): + if isinstance(body, (IOBase, bytes)): _content = body else: - _content = json.dumps(body, cls=AzureJSONEncoder) # type: ignore + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_cancer_profiling_infer_cancer_profile_request( - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, + _request = build_cancer_profiling_infer_cancer_profile_request( content_type=content_type, api_version=self._config.api_version, content=_content, @@ -127,218 +108,2277 @@ def _infer_cancer_profile_initial( path_format_arguments = { "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [200, 202]: + if response.status_code not in [202]: + if _stream: + response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) - deserialized = None response_headers = {} - if response.status_code == 200: - deserialized = _deserialize(_models.OncoPhenotypeResult, response.json()) + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) - if response.status_code == 202: - response_headers["Operation-Location"] = self._deserialize( - "str", response.headers.get("Operation-Location") - ) - response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) - response_headers["Repeatability-Result"] = self._deserialize( - "str", response.headers.get("Repeatability-Result") - ) + deserialized = _deserialize(JSON, response.json()) if cls: - return cls(pipeline_response, deserialized, response_headers) + return cls(pipeline_response, deserialized, response_headers) # type: ignore - return deserialized + return deserialized # type: ignore @overload def begin_infer_cancer_profile( - self, - body: _models.OncoPhenotypeData, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> LROPoller[_models.OncoPhenotypeResult]: + self, body: _models.OncoPhenotypeData, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. :param body: Required. :type body: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeData - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns OncoPhenotypeResult. The OncoPhenotypeResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "checkForCancerCase": bool, # Optional. An indication whether to + perform a preliminary step on the patient's documents to determine whether + they relate to a Cancer case. + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceTypes": [ + "str" # Optional. A list of inference types to be inferred + for the current request. This could be used if only part of the Onco + Phenotype inferences are required. If this list is omitted or empty, the + model will return all the inference types. + ], + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ @overload def begin_infer_cancer_profile( - self, - body: JSON, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> LROPoller[_models.OncoPhenotypeResult]: + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. :param body: Required. :type body: JSON - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns OncoPhenotypeResult. The OncoPhenotypeResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ @overload def begin_infer_cancer_profile( - self, - body: IO, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> LROPoller[_models.OncoPhenotypeResult]: + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. :param body: Required. - :type body: IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime + :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns OncoPhenotypeResult. The OncoPhenotypeResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ @distributed_trace def begin_infer_cancer_profile( - self, - body: Union[_models.OncoPhenotypeData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> LROPoller[_models.OncoPhenotypeResult]: + self, body: Union[_models.OncoPhenotypeData, JSON, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. - :param body: Is one of the following types: OncoPhenotypeData, JSON, IO Required. - :type body: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeData or JSON or IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns OncoPhenotypeResult. The OncoPhenotypeResult is - compatible with MutableMapping + :param body: Is one of the following types: OncoPhenotypeData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeData or JSON or IO[bytes] + :return: An instance of LROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "checkForCancerCase": bool, # Optional. An indication whether to + perform a preliminary step on the patient's documents to determine whether + they relate to a Cancer case. + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceTypes": [ + "str" # Optional. A list of inference types to be inferred + for the current request. This could be used if only part of the Onco + Phenotype inferences are required. If this list is omitted or empty, the + model will return all the inference types. + ], + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.OncoPhenotypeResult] = kwargs.pop("cls", None) + cls: ClsType[_models.OncoPhenotypeInferenceResult] = kwargs.pop("cls", None) polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token: Optional[str] = kwargs.pop("continuation_token", None) if cont_token is None: raw_result = self._infer_cancer_profile_initial( - body=body, - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, - content_type=content_type, - cls=lambda x, y, z: x, - headers=_headers, - params=_params, - **kwargs + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs ) kwargs.pop("error_map", None) def get_long_running_output(pipeline_response): + response_headers = {} response = pipeline_response.http_response - deserialized = _deserialize(_models.OncoPhenotypeResult, response.json()) + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.OncoPhenotypeInferenceResult, response.json().get("result")) if cls: - return cls(pipeline_response, deserialized, {}) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized path_format_arguments = { @@ -354,10 +2394,12 @@ def get_long_running_output(pipeline_response): else: polling_method = polling if cont_token: - return LROPoller.from_continuation_token( + return LROPoller[_models.OncoPhenotypeInferenceResult].from_continuation_token( polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output, ) - return LROPoller(self._client, raw_result, get_long_running_output, polling_method) # type: ignore + return LROPoller[_models.OncoPhenotypeInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_serialization.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_serialization.py index f17c068e833e..2f781d740827 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_serialization.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/_serialization.py @@ -63,8 +63,8 @@ import isodate # type: ignore -from azure.core.exceptions import DeserializationError, SerializationError, raise_with_traceback -from azure.core.serialization import NULL as AzureCoreNull +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull _BOM = codecs.BOM_UTF8.decode(encoding="utf-8") @@ -124,7 +124,7 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: pass return ET.fromstring(data_as_str) # nosec - except ET.ParseError: + except ET.ParseError as err: # It might be because the server has an issue, and returned JSON with # content-type XML.... # So let's try a JSON load, and if it's still broken @@ -143,7 +143,7 @@ def _json_attemp(data): # The function hack is because Py2.7 messes up with exception # context otherwise. _LOGGER.critical("Wasn't XML not JSON, failing") - raise_with_traceback(DeserializationError, "XML is invalid") + raise DeserializationError("XML is invalid") from err raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) @classmethod @@ -170,13 +170,6 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], return None -try: - basestring # type: ignore - unicode_str = unicode # type: ignore -except NameError: - basestring = str - unicode_str = str - _LOGGER = logging.getLogger(__name__) try: @@ -295,7 +288,7 @@ class Model(object): _validation: Dict[str, Dict[str, Any]] = {} def __init__(self, **kwargs: Any) -> None: - self.additional_properties: Dict[str, Any] = {} + self.additional_properties: Optional[Dict[str, Any]] = {} for k in kwargs: if k not in self._attribute_map: _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) @@ -340,7 +333,7 @@ def _create_xml_node(cls): return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: - """Return the JSON that would be sent to azure from this model. + """Return the JSON that would be sent to server from this model. This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. @@ -351,7 +344,7 @@ def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore def as_dict( self, @@ -390,7 +383,7 @@ def my_key_transformer(key, attr_desc, value): :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore @classmethod def _infer_class_models(cls): @@ -415,7 +408,7 @@ def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = N :raises: DeserializationError if something went wrong """ deserializer = Deserializer(cls._infer_class_models()) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def from_dict( @@ -445,7 +438,7 @@ def from_dict( if key_extractors is None else key_extractors ) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def _flatten_subtype(cls, key, objects): @@ -545,7 +538,7 @@ class Serializer(object): "multiple": lambda x, y: x % y != 0, } - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.serialize_type = { "iso-8601": Serializer.serialize_iso, "rfc-1123": Serializer.serialize_rfc, @@ -561,7 +554,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "[]": self.serialize_iter, "{}": self.serialize_dict, } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: Dict[str, type] = dict(classes) if classes else {} self.key_transformer = full_restapi_key_transformer self.client_side_validation = True @@ -629,7 +622,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): if xml_desc.get("attr", False): if xml_ns: ET.register_namespace(xml_prefix, xml_ns) - xml_name = "{}{}".format(xml_ns, xml_name) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) serialized.set(xml_name, new_attr) # type: ignore continue if xml_desc.get("text", False): @@ -649,7 +642,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): else: # That's a basic type # Integrate namespace if necessary local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) - local_node.text = unicode_str(new_attr) + local_node.text = str(new_attr) serialized.append(local_node) # type: ignore else: # JSON for k in reversed(keys): # type: ignore @@ -662,12 +655,13 @@ def _serialize(self, target_obj, data_type=None, **kwargs): _serialized.update(_new_attr) # type: ignore _new_attr = _new_attr[k] # type: ignore _serialized = _serialized[k] - except ValueError: - continue + except ValueError as err: + if isinstance(err, SerializationError): + raise except (AttributeError, KeyError, TypeError) as err: msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) - raise_with_traceback(SerializationError, msg, err) + raise SerializationError(msg) from err else: return serialized @@ -709,7 +703,7 @@ def body(self, data, data_type, **kwargs): ] data = deserializer._deserialize(data_type, data) except DeserializationError as err: - raise_with_traceback(SerializationError, "Unable to build a model: " + str(err), err) + raise SerializationError("Unable to build a model: " + str(err)) from err return self._serialize(data, data_type, **kwargs) @@ -729,6 +723,7 @@ def url(self, name, data, data_type, **kwargs): if kwargs.get("skip_quote") is True: output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) else: output = quote(str(output), safe="") except SerializationError: @@ -741,7 +736,9 @@ def query(self, name, data, data_type, **kwargs): :param data: The data to be serialized. :param str data_type: The type to be serialized from. - :rtype: str + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list :raises: TypeError if serialization fails. :raises: ValueError if data is None """ @@ -749,10 +746,8 @@ def query(self, name, data, data_type, **kwargs): # Treat the list aside, since we don't want to encode the div separator if data_type.startswith("["): internal_data_type = data_type[1:-1] - data = [self.serialize_data(d, internal_data_type, **kwargs) if d is not None else "" for d in data] - if not kwargs.get("skip_quote", False): - data = [quote(str(d), safe="") for d in data] - return str(self.serialize_iter(data, internal_data_type, **kwargs)) + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) # Not a list, regular serialization output = self.serialize_data(data, data_type, **kwargs) @@ -803,7 +798,7 @@ def serialize_data(self, data, data_type, **kwargs): raise ValueError("No value for given attribute") try: - if data is AzureCoreNull: + if data is CoreNull: return None if data_type in self.basic_types.values(): return self.serialize_basic(data, data_type, **kwargs) @@ -823,7 +818,7 @@ def serialize_data(self, data, data_type, **kwargs): except (ValueError, TypeError) as err: msg = "Unable to serialize value: {!r} as type: {!r}." - raise_with_traceback(SerializationError, msg.format(data, data_type), err) + raise SerializationError(msg.format(data, data_type)) from err else: return self._serialize(data, **kwargs) @@ -891,6 +886,8 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): not be None or empty. :param str div: If set, this str will be used to combine the elements in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. :rtype: list, str """ if isinstance(data, str): @@ -903,9 +900,14 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): for d in data: try: serialized.append(self.serialize_data(d, iter_type, **kwargs)) - except ValueError: + except ValueError as err: + if isinstance(err, SerializationError): + raise serialized.append(None) + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + if div: serialized = ["" if s is None else str(s) for s in serialized] serialized = div.join(serialized) @@ -950,7 +952,9 @@ def serialize_dict(self, attr, dict_type, **kwargs): for key, value in attr.items(): try: serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) - except ValueError: + except ValueError as err: + if isinstance(err, SerializationError): + raise serialized[self.serialize_unicode(key)] = None if "xml" in serialization_ctxt: @@ -983,7 +987,7 @@ def serialize_object(self, attr, **kwargs): return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) if obj_type is _long_type: return self.serialize_long(attr) - if obj_type is unicode_str: + if obj_type is str: return self.serialize_unicode(attr) if obj_type is datetime.datetime: return self.serialize_iso(attr) @@ -1160,10 +1164,10 @@ def serialize_iso(attr, **kwargs): return date + microseconds + "Z" except (ValueError, OverflowError) as err: msg = "Unable to serialize datetime object." - raise_with_traceback(SerializationError, msg, err) + raise SerializationError(msg) from err except AttributeError as err: msg = "ISO-8601 object must be valid Datetime object." - raise_with_traceback(TypeError, msg, err) + raise TypeError(msg) from err @staticmethod def serialize_unix(attr, **kwargs): @@ -1199,7 +1203,6 @@ def rest_key_extractor(attr, attr_desc, data): if working_data is None: # If at any point while following flatten JSON path see None, it means # that all properties under are None as well - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) @@ -1220,7 +1223,6 @@ def rest_key_case_insensitive_extractor(attr, attr_desc, data): if working_data is None: # If at any point while following flatten JSON path see None, it means # that all properties under are None as well - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) @@ -1271,7 +1273,7 @@ def _extract_name_from_internal_type(internal_type): xml_name = internal_type_xml_map.get("name", internal_type.__name__) xml_ns = internal_type_xml_map.get("ns", None) if xml_ns: - xml_name = "{}{}".format(xml_ns, xml_name) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) return xml_name @@ -1295,7 +1297,7 @@ def xml_key_extractor(attr, attr_desc, data): # Integrate namespace if necessary xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) if xml_ns: - xml_name = "{}{}".format(xml_ns, xml_name) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) # If it's an attribute, that's simple if xml_desc.get("attr", False): @@ -1361,7 +1363,7 @@ class Deserializer(object): valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.deserialize_type = { "iso-8601": Deserializer.deserialize_iso, "rfc-1123": Deserializer.deserialize_rfc, @@ -1381,7 +1383,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "duration": (isodate.Duration, datetime.timedelta), "iso-8601": (datetime.datetime), } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: Dict[str, type] = dict(classes) if classes else {} self.key_extractors = [rest_key_extractor, xml_key_extractor] # Additional properties only works if the "rest_key_extractor" is used to # extract the keys. Making it to work whatever the key extractor is too much @@ -1434,7 +1436,7 @@ def _deserialize(self, target_obj, data): response, class_name = self._classify_target(target_obj, data) - if isinstance(response, basestring): + if isinstance(response, str): return self.deserialize_data(data, response) elif isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) @@ -1471,7 +1473,7 @@ def _deserialize(self, target_obj, data): d_attrs[attr] = value except (AttributeError, TypeError, KeyError) as err: msg = "Unable to deserialize to object: " + class_name # type: ignore - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: additional_properties = self._build_additional_properties(attributes, data) return self._instantiate_model(response, d_attrs, additional_properties) @@ -1505,14 +1507,14 @@ def _classify_target(self, target, data): if target is None: return None, None - if isinstance(target, basestring): + if isinstance(target, str): try: target = self.dependencies[target] except KeyError: return target, target try: - target = target._classify(data, self.dependencies) + target = target._classify(data, self.dependencies) # type: ignore except AttributeError: pass # Target is not a Model, no classify return target, target.__class__.__name__ # type: ignore @@ -1568,7 +1570,7 @@ def _unpack_content(raw_data, content_type=None): if hasattr(raw_data, "_content_consumed"): return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) - if isinstance(raw_data, (basestring, bytes)) or hasattr(raw_data, "read"): + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore return raw_data @@ -1642,7 +1644,7 @@ def deserialize_data(self, data, data_type): except (ValueError, TypeError, AttributeError) as err: msg = "Unable to deserialize response data." msg += " Data: {}, {}".format(data, data_type) - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return self._deserialize(obj_type, data) @@ -1690,7 +1692,7 @@ def deserialize_object(self, attr, **kwargs): if isinstance(attr, ET.Element): # Do no recurse on XML, just return the tree as-is return attr - if isinstance(attr, basestring): + if isinstance(attr, str): return self.deserialize_basic(attr, "str") obj_type = type(attr) if obj_type in self.basic_types: @@ -1747,7 +1749,7 @@ def deserialize_basic(self, attr, data_type): if data_type == "bool": if attr in [True, False, 1, 0]: return bool(attr) - elif isinstance(attr, basestring): + elif isinstance(attr, str): if attr.lower() in ["true", "1"]: return True elif attr.lower() in ["false", "0"]: @@ -1798,7 +1800,6 @@ def deserialize_enum(data, enum_obj): data = data.value if isinstance(data, int): # Workaround. We might consider remove it in the future. - # https://github.com/Azure/azure-rest-api-specs/issues/141 try: return list(enum_obj.__members__.values())[data] except IndexError: @@ -1852,10 +1853,10 @@ def deserialize_decimal(attr): if isinstance(attr, ET.Element): attr = attr.text try: - return decimal.Decimal(attr) # type: ignore + return decimal.Decimal(str(attr)) # type: ignore except decimal.DecimalException as err: msg = "Invalid decimal {}".format(attr) - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err @staticmethod def deserialize_long(attr): @@ -1883,7 +1884,7 @@ def deserialize_duration(attr): duration = isodate.parse_duration(attr) except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize duration object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return duration @@ -1900,7 +1901,7 @@ def deserialize_date(attr): if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore raise DeserializationError("Date must have only digits and -. Received: %s" % attr) # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. - return isodate.parse_date(attr, defaultmonth=None, defaultday=None) + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) @staticmethod def deserialize_time(attr): @@ -1935,7 +1936,7 @@ def deserialize_rfc(attr): date_obj = date_obj.astimezone(tz=TZ_UTC) except ValueError as err: msg = "Cannot deserialize to rfc datetime object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return date_obj @@ -1972,7 +1973,7 @@ def deserialize_iso(attr): raise OverflowError("Hit max or min date") except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize datetime object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return date_obj @@ -1988,9 +1989,10 @@ def deserialize_unix(attr): if isinstance(attr, ET.Element): attr = int(attr.text) # type: ignore try: + attr = int(attr) date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) except ValueError as err: msg = "Cannot deserialize to unix datetime object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return date_obj diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_client.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_client.py index f1c88e35b696..499a09b530f7 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_client.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_client.py @@ -11,6 +11,7 @@ from azure.core import AsyncPipelineClient from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies from azure.core.rest import AsyncHttpResponse, HttpRequest from .._serialization import Deserializer, Serializer @@ -27,7 +28,7 @@ class CancerProfilingClient(CancerProfilingClientOperationsMixin): # pylint: di :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str :keyword int polling_interval: Default waiting time between two polls for LRO operations if no @@ -35,15 +36,34 @@ class CancerProfilingClient(CancerProfilingClientOperationsMixin): # pylint: di """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - _endpoint = "{endpoint}/healthinsights" + _endpoint = "{endpoint}/health-insights" self._config = CancerProfilingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, config=self._config, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) self._serialize = Serializer() self._deserialize = Deserializer() self._serialize.client_side_validation = False - def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]: + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -67,7 +87,7 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHt } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore async def close(self) -> None: await self._client.close() diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_configuration.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_configuration.py index 9bbb5f047bd0..4400e512cc83 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_configuration.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_configuration.py @@ -6,22 +6,15 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import sys from typing import Any -from azure.core.configuration import Configuration from azure.core.credentials import AzureKeyCredential from azure.core.pipeline import policies from .._version import VERSION -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - -class CancerProfilingClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes +class CancerProfilingClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long """Configuration for CancerProfilingClient. Note that all parameters used to create this instance are saved as instance @@ -33,14 +26,13 @@ class CancerProfilingClientConfiguration(Configuration): # pylint: disable=too- :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - super(CancerProfilingClientConfiguration, self).__init__(**kwargs) - api_version: Literal["2023-03-01-preview"] = kwargs.pop("api_version", "2023-03-01-preview") + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -51,6 +43,7 @@ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) self.credential = credential self.api_version = api_version kwargs.setdefault("sdk_moniker", "healthinsights-cancerprofiling/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -59,9 +52,9 @@ def _configure(self, **kwargs: Any) -> None: self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) - self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) self.authentication_policy = kwargs.get("authentication_policy") if self.credential and not self.authentication_policy: self.authentication_policy = policies.AzureKeyCredentialPolicy( diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_operations/_operations.py index 7d03f6f8261a..d3bed641b89f 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_operations/_operations.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/aio/_operations/_operations.py @@ -1,4 +1,4 @@ -# pylint: disable=too-many-lines +# pylint: disable=too-many-lines,too-many-statements # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -6,7 +6,7 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import datetime +from io import IOBase import json import sys from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload @@ -20,15 +20,14 @@ map_error, ) from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import AsyncHttpResponse from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod from azure.core.polling.async_base_polling import AsyncLROBasePolling -from azure.core.rest import HttpRequest +from azure.core.rest import AsyncHttpResponse, HttpRequest from azure.core.tracing.decorator_async import distributed_trace_async from azure.core.utils import case_insensitive_dict from ... import models as _models -from ..._model_base import AzureJSONEncoder, _deserialize +from ..._model_base import SdkJSONEncoder, _deserialize from ..._operations._operations import build_cancer_profiling_infer_cancer_profile_request from .._vendor import CancerProfilingClientMixinABC @@ -43,13 +42,8 @@ class CancerProfilingClientOperationsMixin(CancerProfilingClientMixinABC): async def _infer_cancer_profile_initial( - self, - body: Union[_models.OncoPhenotypeData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> Optional[_models.OncoPhenotypeResult]: + self, body: Union[_models.OncoPhenotypeData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: error_map = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, @@ -62,18 +56,16 @@ async def _infer_cancer_profile_initial( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[Optional[_models.OncoPhenotypeResult]] = kwargs.pop("cls", None) + cls: ClsType[JSON] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None - if isinstance(body, (IO, bytes)): + if isinstance(body, (IOBase, bytes)): _content = body else: - _content = json.dumps(body, cls=AzureJSONEncoder) # type: ignore + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_cancer_profiling_infer_cancer_profile_request( - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, + _request = build_cancer_profiling_infer_cancer_profile_request( content_type=content_type, api_version=self._config.api_version, content=_content, @@ -83,218 +75,2277 @@ async def _infer_cancer_profile_initial( path_format_arguments = { "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [200, 202]: + if response.status_code not in [202]: + if _stream: + await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) - deserialized = None response_headers = {} - if response.status_code == 200: - deserialized = _deserialize(_models.OncoPhenotypeResult, response.json()) + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) - if response.status_code == 202: - response_headers["Operation-Location"] = self._deserialize( - "str", response.headers.get("Operation-Location") - ) - response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) - response_headers["Repeatability-Result"] = self._deserialize( - "str", response.headers.get("Repeatability-Result") - ) + deserialized = _deserialize(JSON, response.json()) if cls: - return cls(pipeline_response, deserialized, response_headers) + return cls(pipeline_response, deserialized, response_headers) # type: ignore - return deserialized + return deserialized # type: ignore @overload async def begin_infer_cancer_profile( - self, - body: _models.OncoPhenotypeData, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> AsyncLROPoller[_models.OncoPhenotypeResult]: + self, body: _models.OncoPhenotypeData, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. :param body: Required. :type body: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeData - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns OncoPhenotypeResult. The - OncoPhenotypeResult is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "checkForCancerCase": bool, # Optional. An indication whether to + perform a preliminary step on the patient's documents to determine whether + they relate to a Cancer case. + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceTypes": [ + "str" # Optional. A list of inference types to be inferred + for the current request. This could be used if only part of the Onco + Phenotype inferences are required. If this list is omitted or empty, the + model will return all the inference types. + ], + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ @overload async def begin_infer_cancer_profile( - self, - body: JSON, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> AsyncLROPoller[_models.OncoPhenotypeResult]: + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. :param body: Required. :type body: JSON - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns OncoPhenotypeResult. The - OncoPhenotypeResult is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ @overload async def begin_infer_cancer_profile( - self, - body: IO, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> AsyncLROPoller[_models.OncoPhenotypeResult]: + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. :param body: Required. - :type body: IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime + :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns OncoPhenotypeResult. The - OncoPhenotypeResult is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ @distributed_trace_async async def begin_infer_cancer_profile( - self, - body: Union[_models.OncoPhenotypeData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> AsyncLROPoller[_models.OncoPhenotypeResult]: + self, body: Union[_models.OncoPhenotypeData, JSON, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.OncoPhenotypeInferenceResult]: + # pylint: disable=line-too-long """Create Onco Phenotype job. Creates an Onco Phenotype job with the given request body. - :param body: Is one of the following types: OncoPhenotypeData, JSON, IO Required. - :type body: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeData or JSON or IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns OncoPhenotypeResult. The - OncoPhenotypeResult is compatible with MutableMapping + :param body: Is one of the following types: OncoPhenotypeData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeData or JSON or IO[bytes] + :return: An instance of AsyncLROPoller that returns OncoPhenotypeInferenceResult. The + OncoPhenotypeInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "checkForCancerCase": bool, # Optional. An indication whether to + perform a preliminary step on the patient's documents to determine whether + they relate to a Cancer case. + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceTypes": [ + "str" # Optional. A list of inference types to be inferred + for the current request. This could be used if only part of the Onco + Phenotype inferences are required. If this list is omitted or empty, the + model will return all the inference types. + ], + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Onco + Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", + "clinicalStageM", "pathologicStageT", "pathologicStageN", + "pathologicStageM", and "diagnosisDate". + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "caseId": "str", # Optional. An identifier + for a clinical case, if there are multiple clinical cases + regarding the same patient. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ] + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } """ _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.OncoPhenotypeResult] = kwargs.pop("cls", None) + cls: ClsType[_models.OncoPhenotypeInferenceResult] = kwargs.pop("cls", None) polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token: Optional[str] = kwargs.pop("continuation_token", None) if cont_token is None: raw_result = await self._infer_cancer_profile_initial( - body=body, - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, - content_type=content_type, - cls=lambda x, y, z: x, - headers=_headers, - params=_params, - **kwargs + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs ) kwargs.pop("error_map", None) def get_long_running_output(pipeline_response): + response_headers = {} response = pipeline_response.http_response - deserialized = _deserialize(_models.OncoPhenotypeResult, response.json()) + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.OncoPhenotypeInferenceResult, response.json().get("result")) if cls: - return cls(pipeline_response, deserialized, {}) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized path_format_arguments = { @@ -311,10 +2362,12 @@ def get_long_running_output(pipeline_response): else: polling_method = polling if cont_token: - return AsyncLROPoller.from_continuation_token( + return AsyncLROPoller[_models.OncoPhenotypeInferenceResult].from_continuation_token( polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output, ) - return AsyncLROPoller(self._client, raw_result, get_long_running_output, polling_method) # type: ignore + return AsyncLROPoller[_models.OncoPhenotypeInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/__init__.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/__init__.py index a962e8202086..ff6e41fe64dc 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/__init__.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/__init__.py @@ -8,27 +8,47 @@ from ._models import ClinicalCodedElement from ._models import ClinicalNoteEvidence +from ._models import CodeableConcept +from ._models import Coding +from ._models import DocumentAdministrativeMetadata +from ._models import DocumentAuthor from ._models import DocumentContent +from ._models import Element +from ._models import Encounter from ._models import Error +from ._models import Extension +from ._models import HealthInsightsOperationStatus +from ._models import Identifier from ._models import InferenceEvidence from ._models import InnerError +from ._models import Meta from ._models import OncoPhenotypeData from ._models import OncoPhenotypeInference +from ._models import OncoPhenotypeInferenceResult from ._models import OncoPhenotypeModelConfiguration from ._models import OncoPhenotypePatientResult -from ._models import OncoPhenotypeResult -from ._models import OncoPhenotypeResults +from ._models import OrderedProcedure +from ._models import PatientDetails from ._models import PatientDocument -from ._models import PatientInfo from ._models import PatientRecord +from ._models import Period +from ._models import Quantity +from ._models import Range +from ._models import Ratio +from ._models import Reference +from ._models import Resource +from ._models import SampledData +from ._models import TimePeriod from ._enums import ClinicalDocumentType from ._enums import DocumentContentSourceType from ._enums import DocumentType +from ._enums import EncounterClass from ._enums import JobStatus from ._enums import OncoPhenotypeInferenceType -from ._enums import PatientInfoSex -from ._enums import RepeatabilityResultType +from ._enums import PatientSex +from ._enums import RepeatabilityResult +from ._enums import SpecialtyType from ._patch import __all__ as _patch_all from ._patch import * # pylint: disable=unused-wildcard-import from ._patch import patch_sdk as _patch_sdk @@ -36,26 +56,46 @@ __all__ = [ "ClinicalCodedElement", "ClinicalNoteEvidence", + "CodeableConcept", + "Coding", + "DocumentAdministrativeMetadata", + "DocumentAuthor", "DocumentContent", + "Element", + "Encounter", "Error", + "Extension", + "HealthInsightsOperationStatus", + "Identifier", "InferenceEvidence", "InnerError", + "Meta", "OncoPhenotypeData", "OncoPhenotypeInference", + "OncoPhenotypeInferenceResult", "OncoPhenotypeModelConfiguration", "OncoPhenotypePatientResult", - "OncoPhenotypeResult", - "OncoPhenotypeResults", + "OrderedProcedure", + "PatientDetails", "PatientDocument", - "PatientInfo", "PatientRecord", + "Period", + "Quantity", + "Range", + "Ratio", + "Reference", + "Resource", + "SampledData", + "TimePeriod", "ClinicalDocumentType", "DocumentContentSourceType", "DocumentType", + "EncounterClass", "JobStatus", "OncoPhenotypeInferenceType", - "PatientInfoSex", - "RepeatabilityResultType", + "PatientSex", + "RepeatabilityResult", + "SpecialtyType", ] __all__.extend([p for p in _patch_all if p not in __all__]) _patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_enums.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_enums.py index 82887a036e6b..29abd27255ca 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_enums.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_enums.py @@ -16,11 +16,11 @@ class ClinicalDocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): CONSULTATION = "consultation" DISCHARGE_SUMMARY = "dischargeSummary" HISTORY_AND_PHYSICAL = "historyAndPhysical" + RADIOLOGY_REPORT = "radiologyReport" PROCEDURE = "procedure" PROGRESS = "progress" - IMAGING = "imaging" LABORATORY = "laboratory" - PATHOLOGY = "pathology" + PATHOLOGY_REPORT = "pathologyReport" class DocumentContentSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -30,7 +30,9 @@ class DocumentContentSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): """ INLINE = "inline" + """The content is given as a string (for instance, text).""" REFERENCE = "reference" + """The content is given as a URI.""" class DocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -44,6 +46,35 @@ class DocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): GENOMIC_SEQUENCING = "genomicSequencing" +class EncounterClass(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR + value set--http://....). + """ + + IN_PATIENT = "inpatient" + """A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned + to a location where patients generally stay at least overnight and provided with room, board, + and continuous nursing service.""" + AMBULATORY = "ambulatory" + """The term ambulatory usually implies that the patient has come to the location and is not + assigned to a bed. Sometimes referred to as an outpatient encounter.""" + OBSERVATION = "observation" + """An encounter where the patient usually will start in different encounter, such as one in the + emergency department but then transition to this type of encounter because they require a + significant period of treatment and monitoring to determine whether or not their condition + warrants an inpatient admission or discharge.""" + EMERGENCY = "emergency" + """A patient encounter that takes place at a dedicated healthcare service delivery location where + the patient receives immediate evaluation and treatment, provided until the patient can be + discharged or responsibility for the patient's care is transferred elsewhere (for example, the + patient could be admitted as an inpatient or transferred to another facility.""" + VIRTUAL = "virtual" + """A patient encounter where the patient is not physically present for the encounter, such as in a + telehealth encounter, phone call, or electronic communication.""" + HEALTH_HOME = "healthHome" + """Healthcare encounter that takes place in the residence of the patient or a designee""" + + class JobStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): """The status of the processing job.""" @@ -51,7 +82,7 @@ class JobStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): RUNNING = "running" SUCCEEDED = "succeeded" FAILED = "failed" - PARTIALLY_COMPLETED = "partiallyCompleted" + CANCELED = "canceled" class OncoPhenotypeInferenceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -65,9 +96,10 @@ class OncoPhenotypeInferenceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): PATHOLOGIC_STAGE_T = "pathologicStageT" PATHOLOGIC_STAGE_N = "pathologicStageN" PATHOLOGIC_STAGE_M = "pathologicStageM" + DIAGNOSIS_DATE = "diagnosisDate" -class PatientInfoSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): +class PatientSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): """The patient's sex.""" FEMALE = "female" @@ -75,8 +107,23 @@ class PatientInfoSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): UNSPECIFIED = "unspecified" -class RepeatabilityResultType(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Type of RepeatabilityResultType.""" +class RepeatabilityResult(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Repeatability Result header options.""" ACCEPTED = "accepted" + """If the request was accepted and the server guarantees that the server state reflects a single + execution of the operation.""" REJECTED = "rejected" + """If the request was rejected because the combination of Repeatability-First-Sent and + Repeatability-Request-ID were invalid + or because the Repeatability-First-Sent value was outside the range of values held by the + server.""" + + +class SpecialtyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the type of the Specialty.""" + + PATHOLOGY = "pathology" + """pathology""" + RADIOLOGY = "radiology" + """radiology""" diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_models.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_models.py index f91de6cc4e79..e5460b5aa588 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_models.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/azure/healthinsights/cancerprofiling/models/_models.py @@ -21,7 +21,7 @@ class ClinicalCodedElement(_model_base.Model): """A piece of clinical information, expressed as a code in a clinical coding system. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar system: The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. :vartype system: str @@ -34,13 +34,13 @@ class ClinicalCodedElement(_model_base.Model): """ system: str = rest_field() - """The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. """ + """The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required.""" code: str = rest_field() - """The code within the given clinical coding system. Required. """ + """The code within the given clinical coding system. Required.""" name: Optional[str] = rest_field() - """The name of this coded concept in the coding system. """ + """The name of this coded concept in the coding system.""" value: Optional[str] = rest_field() - """A value associated with the code within the given clinical coding system. """ + """A value associated with the code within the given clinical coding system.""" @overload def __init__( @@ -67,7 +67,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class ClinicalNoteEvidence(_model_base.Model): """A piece of evidence from a clinical note (text document). - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar id: The identifier of the document containing the evidence. Required. :vartype id: str @@ -80,13 +80,13 @@ class ClinicalNoteEvidence(_model_base.Model): """ id: str = rest_field() - """The identifier of the document containing the evidence. Required. """ + """The identifier of the document containing the evidence. Required.""" text: Optional[str] = rest_field() - """The actual text span which is evidence for the inference. """ + """The actual text span which is evidence for the inference.""" offset: int = rest_field() - """The start index of the evidence text span in the document (0 based). Required. """ + """The start index of the evidence text span in the document (0 based). Required.""" length: int = rest_field() - """The length of the evidence text span. Required. """ + """The length of the evidence text span. Required.""" @overload def __init__( @@ -110,35 +110,959 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) +class Element(_model_base.Model): + """The base definition for all elements contained inside a resource. + Based on `FHIR Element `_. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.cancerprofiling.models.Extension] + """ + + id: Optional[str] = rest_field() + """Unique id for inter-element referencing.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CodeableConcept(Element): + """Concept - reference to a terminology or just text + Based on `FHIR CodeableConcept `_. + + :ivar coding: Code defined by a terminology system. + :vartype coding: list[~azure.healthinsights.cancerprofiling.models.Coding] + :ivar text: Plain text representation of the concept. + :vartype text: str + """ + + coding: Optional[List["_models.Coding"]] = rest_field() + """Code defined by a terminology system.""" + text: Optional[str] = rest_field() + """Plain text representation of the concept.""" + + @overload + def __init__( + self, + *, + coding: Optional[List["_models.Coding"]] = None, + text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Coding(Element): + """A Coding is a representation of a defined concept using a symbol from a defined "code system". + Based on `FHIR Coding `_. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.cancerprofiling.models.Extension] + :ivar system: Identity of the terminology system. + :vartype system: str + :ivar version: Version of the system - if relevant. + :vartype version: str + :ivar code: Symbol in syntax defined by the system. + :vartype code: str + :ivar display: Representation defined by the system. + :vartype display: str + """ + + system: Optional[str] = rest_field() + """Identity of the terminology system.""" + version: Optional[str] = rest_field() + """Version of the system - if relevant.""" + code: Optional[str] = rest_field() + """Symbol in syntax defined by the system.""" + display: Optional[str] = rest_field() + """Representation defined by the system.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + system: Optional[str] = None, + version: Optional[str] = None, + code: Optional[str] = None, + display: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAdministrativeMetadata(_model_base.Model): + """Document administrative metadata. + + :ivar ordered_procedures: List of procedure information associated with the document. + :vartype ordered_procedures: + list[~azure.healthinsights.cancerprofiling.models.OrderedProcedure] + :ivar encounter_id: Reference to the encounter associated with the document. + :vartype encounter_id: str + """ + + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = rest_field(name="orderedProcedures") + """List of procedure information associated with the document.""" + encounter_id: Optional[str] = rest_field(name="encounterId") + """Reference to the encounter associated with the document.""" + + @overload + def __init__( + self, + *, + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = None, + encounter_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAuthor(_model_base.Model): + """Document author. + + :ivar id: author id. + :vartype id: str + :ivar full_name: Text representation of the full name. + :vartype full_name: str + """ + + id: Optional[str] = rest_field() + """author id.""" + full_name: Optional[str] = rest_field(name="fullName") + """Text representation of the full name.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + full_name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + class DocumentContent(_model_base.Model): """The content of the patient document. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. + + :ivar source_type: The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: "inline" and "reference". + :vartype source_type: str or + ~azure.healthinsights.cancerprofiling.models.DocumentContentSourceType + :ivar value: The content of the document, given either inline (as a string) or as a reference + (URI). Required. + :vartype value: str + """ + + source_type: Union[str, "_models.DocumentContentSourceType"] = rest_field(name="sourceType") + """The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: \"inline\" and \"reference\".""" + value: str = rest_field() + """The content of the document, given either inline (as a string) or as a reference (URI). + Required.""" + + @overload + def __init__( + self, + *, + source_type: Union[str, "_models.DocumentContentSourceType"], + value: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Encounter(_model_base.Model): + """visit/encounter information. + + All required parameters must be populated in order to send to server. + + :ivar id: The id of the visit. Required. + :vartype id: str + :ivar period: Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end + to indicate the discharge time. + :vartype period: ~azure.healthinsights.cancerprofiling.models.TimePeriod + :ivar class_property: The class of the encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + :vartype class_property: str or ~azure.healthinsights.cancerprofiling.models.EncounterClass + """ + + id: str = rest_field() + """The id of the visit. Required.""" + period: Optional["_models.TimePeriod"] = rest_field() + """Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to + indicate the discharge time.""" + class_property: Optional[Union[str, "_models.EncounterClass"]] = rest_field(name="class") + """The class of the encounter. Known values are: \"inpatient\", \"ambulatory\", \"observation\", + \"emergency\", \"virtual\", and \"healthHome\".""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + period: Optional["_models.TimePeriod"] = None, + class_property: Optional[Union[str, "_models.EncounterClass"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Error(_model_base.Model): + """The error object. + + All required parameters must be populated in order to send to server. + + :ivar code: One of a server-defined set of error codes. Required. + :vartype code: str + :ivar message: A human-readable representation of the error. Required. + :vartype message: str + :ivar target: The target of the error. + :vartype target: str + :ivar details: An array of details about specific errors that led to this reported error. + :vartype details: list[~azure.healthinsights.cancerprofiling.models.Error] + :ivar innererror: An object containing more specific information than the current object about + the error. + :vartype innererror: ~azure.healthinsights.cancerprofiling.models.InnerError + """ + + code: str = rest_field() + """One of a server-defined set of error codes. Required.""" + message: str = rest_field() + """A human-readable representation of the error. Required.""" + target: Optional[str] = rest_field() + """The target of the error.""" + details: Optional[List["_models.Error"]] = rest_field() + """An array of details about specific errors that led to this reported error.""" + innererror: Optional["_models.InnerError"] = rest_field() + """An object containing more specific information than the current object about the error.""" + + @overload + def __init__( + self, + *, + code: str, + message: str, + target: Optional[str] = None, + details: Optional[List["_models.Error"]] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Extension(Element): # pylint: disable=too-many-instance-attributes + """Base for all elements + Based on `FHIR Element `_. + + All required parameters must be populated in order to send to server. + + :ivar url: Source of the definition for the extension code - a logical name or a URL. Required. + :vartype url: str + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.cancerprofiling.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.cancerprofiling.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.cancerprofiling.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.cancerprofiling.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.cancerprofiling.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.cancerprofiling.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.cancerprofiling.models.Reference + """ + + url: str = rest_field() + """Source of the definition for the extension code - a logical name or a URL. Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + + @overload + def __init__( + self, + *, + url: str, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class HealthInsightsOperationStatus(_model_base.Model): + """Provides status details for long running operations. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: The unique ID of the operation. Required. + :vartype id: str + :ivar status: The status of the operation. Required. Known values are: "notStarted", "running", + "succeeded", "failed", and "canceled". + :vartype status: str or ~azure.healthinsights.cancerprofiling.models.JobStatus + :ivar created_date_time: The date and time when the processing job was created. + :vartype created_date_time: ~datetime.datetime + :ivar expiration_date_time: The date and time when the processing job is set to expire. + :vartype expiration_date_time: ~datetime.datetime + :ivar last_update_date_time: The date and time when the processing job was last updated. + :vartype last_update_date_time: ~datetime.datetime + :ivar error: Error object that describes the error when status is "Failed". + :vartype error: ~azure.healthinsights.cancerprofiling.models.Error + :ivar result: The result of the operation. + :vartype result: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceResult + """ + + id: str = rest_field(visibility=["read"]) + """The unique ID of the operation. Required.""" + status: Union[str, "_models.JobStatus"] = rest_field(visibility=["read"]) + """The status of the operation. Required. Known values are: \"notStarted\", \"running\", + \"succeeded\", \"failed\", and \"canceled\".""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was created.""" + expiration_date_time: Optional[datetime.datetime] = rest_field( + name="expirationDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job is set to expire.""" + last_update_date_time: Optional[datetime.datetime] = rest_field( + name="lastUpdateDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was last updated.""" + error: Optional["_models.Error"] = rest_field() + """Error object that describes the error when status is \"Failed\".""" + result: Optional["_models.OncoPhenotypeInferenceResult"] = rest_field() + """The result of the operation.""" + + @overload + def __init__( + self, + *, + error: Optional["_models.Error"] = None, + result: Optional["_models.OncoPhenotypeInferenceResult"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Identifier(Element): + """An identifier intended for computation + Based on `FHIR Identifier `_. + + :ivar use: usual | official | temp | secondary | old (If known). + :vartype use: str + :ivar type: Description of identifier. + :vartype type: ~azure.healthinsights.cancerprofiling.models.CodeableConcept + :ivar system: The namespace for the identifier value. + :vartype system: str + :ivar value: The value that is unique. + :vartype value: str + :ivar period: Time period when id is/was valid for use. + :vartype period: ~azure.healthinsights.cancerprofiling.models.Period + :ivar assigner: Organization that issued id (may be just text). + :vartype assigner: ~azure.healthinsights.cancerprofiling.models.Reference + """ + + use: Optional[str] = rest_field() + """usual | official | temp | secondary | old (If known).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Description of identifier.""" + system: Optional[str] = rest_field() + """The namespace for the identifier value.""" + value: Optional[str] = rest_field() + """The value that is unique.""" + period: Optional["_models.Period"] = rest_field() + """Time period when id is/was valid for use.""" + assigner: Optional["_models.Reference"] = rest_field() + """Organization that issued id (may be just text).""" + + @overload + def __init__( + self, + *, + use: Optional[str] = None, + type: Optional["_models.CodeableConcept"] = None, + system: Optional[str] = None, + value: Optional[str] = None, + period: Optional["_models.Period"] = None, + assigner: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class InferenceEvidence(_model_base.Model): + """A piece of evidence corresponding to an inference. + + :ivar patient_data_evidence: A piece of evidence from a clinical note (text document). + :vartype patient_data_evidence: + ~azure.healthinsights.cancerprofiling.models.ClinicalNoteEvidence + :ivar patient_info_evidence: A piece of clinical information, expressed as a code in a clinical + coding + system. + :vartype patient_info_evidence: + ~azure.healthinsights.cancerprofiling.models.ClinicalCodedElement + :ivar importance: A value indicating how important this piece of evidence is for the inference. + :vartype importance: float + """ + + patient_data_evidence: Optional["_models.ClinicalNoteEvidence"] = rest_field(name="patientDataEvidence") + """A piece of evidence from a clinical note (text document).""" + patient_info_evidence: Optional["_models.ClinicalCodedElement"] = rest_field(name="patientInfoEvidence") + """A piece of clinical information, expressed as a code in a clinical coding + system.""" + importance: Optional[float] = rest_field() + """A value indicating how important this piece of evidence is for the inference.""" + + @overload + def __init__( + self, + *, + patient_data_evidence: Optional["_models.ClinicalNoteEvidence"] = None, + patient_info_evidence: Optional["_models.ClinicalCodedElement"] = None, + importance: Optional[float] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class InnerError(_model_base.Model): + """An object containing more specific information about the error. As per Microsoft One API + guidelines - + https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + + :ivar code: One of a server-defined set of error codes. + :vartype code: str + :ivar innererror: Inner error. + :vartype innererror: ~azure.healthinsights.cancerprofiling.models.InnerError + """ + + code: Optional[str] = rest_field() + """One of a server-defined set of error codes.""" + innererror: Optional["_models.InnerError"] = rest_field() + """Inner error.""" + + @overload + def __init__( + self, + *, + code: Optional[str] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Meta(_model_base.Model): + """Metadata about a resource + Based on `FHIR Meta `_. + + :ivar version_id: The version specific identifier, as it appears in the version portion of the + URL. This value changes when the resource is created, updated, or deleted. + :vartype version_id: str + :ivar last_updated: When the resource last changed - e.g. when the version changed. + :vartype last_updated: str + :ivar source: A uri that identifies the source system of the resource. This provides a minimal + amount of Provenance information that can be used to track or differentiate the source of + information in the resource. The source may identify another FHIR server, document, message, + database, etc. + :vartype source: str + :ivar profile: A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_. + :vartype profile: list[str] + :ivar security: Security labels applied to this resource. These tags connect specific resources + to the overall security policy and infrastructure. + :vartype security: list[~azure.healthinsights.cancerprofiling.models.Coding] + :ivar tag: Tags applied to this resource. Tags are intended to be used to identify and relate + resources to process and workflow, and applications are not required to consider the tags when + interpreting the meaning of a resource. + :vartype tag: list[~azure.healthinsights.cancerprofiling.models.Coding] + """ + + version_id: Optional[str] = rest_field(name="versionId") + """The version specific identifier, as it appears in the version portion of the URL. This value + changes when the resource is created, updated, or deleted.""" + last_updated: Optional[str] = rest_field(name="lastUpdated") + """When the resource last changed - e.g. when the version changed.""" + source: Optional[str] = rest_field() + """A uri that identifies the source system of the resource. This provides a minimal amount of + Provenance information that can be used to track or differentiate the source of information in + the resource. The source may identify another FHIR server, document, message, database, etc.""" + profile: Optional[List[str]] = rest_field() + """A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_.""" + security: Optional[List["_models.Coding"]] = rest_field() + """Security labels applied to this resource. These tags connect specific resources to the overall + security policy and infrastructure.""" + tag: Optional[List["_models.Coding"]] = rest_field() + """Tags applied to this resource. Tags are intended to be used to identify and relate resources to + process and workflow, and applications are not required to consider the tags when interpreting + the meaning of a resource.""" + + @overload + def __init__( + self, + *, + version_id: Optional[str] = None, + last_updated: Optional[str] = None, + source: Optional[str] = None, + profile: Optional[List[str]] = None, + security: Optional[List["_models.Coding"]] = None, + tag: Optional[List["_models.Coding"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OncoPhenotypeData(_model_base.Model): + """The body of the Onco Phenotype request. + + All required parameters must be populated in order to send to server. + + :ivar patients: The list of patients, including their clinical information and data. Required. + :vartype patients: list[~azure.healthinsights.cancerprofiling.models.PatientRecord] + :ivar configuration: Configuration affecting the Onco Phenotype model's inference. + :vartype configuration: + ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeModelConfiguration + """ + + patients: List["_models.PatientRecord"] = rest_field() + """The list of patients, including their clinical information and data. Required.""" + configuration: Optional["_models.OncoPhenotypeModelConfiguration"] = rest_field() + """Configuration affecting the Onco Phenotype model's inference.""" + + @overload + def __init__( + self, + *, + patients: List["_models.PatientRecord"], + configuration: Optional["_models.OncoPhenotypeModelConfiguration"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OncoPhenotypeInference(_model_base.Model): + """An inference made by the Onco Phenotype model regarding a patient. + + All required parameters must be populated in order to send to server. + + :ivar type: The type of the Onco Phenotype inference. Required. Known values are: "tumorSite", + "histology", "clinicalStageT", "clinicalStageN", "clinicalStageM", "pathologicStageT", + "pathologicStageN", "pathologicStageM", and "diagnosisDate". + :vartype type: str or ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceType + :ivar value: The value of the inference, as relevant for the given inference type. Required. + :vartype value: str + :ivar description: The description corresponding to the inference value. + :vartype description: str + :ivar confidence_score: Confidence score for this inference. + :vartype confidence_score: float + :ivar evidence: The evidence corresponding to the inference value. + :vartype evidence: list[~azure.healthinsights.cancerprofiling.models.InferenceEvidence] + :ivar case_id: An identifier for a clinical case, if there are multiple clinical cases + regarding the same patient. + :vartype case_id: str + """ + + type: Union[str, "_models.OncoPhenotypeInferenceType"] = rest_field() + """The type of the Onco Phenotype inference. Required. Known values are: \"tumorSite\", + \"histology\", \"clinicalStageT\", \"clinicalStageN\", \"clinicalStageM\", + \"pathologicStageT\", \"pathologicStageN\", \"pathologicStageM\", and \"diagnosisDate\".""" + value: str = rest_field() + """The value of the inference, as relevant for the given inference type. Required.""" + description: Optional[str] = rest_field() + """The description corresponding to the inference value.""" + confidence_score: Optional[float] = rest_field(name="confidenceScore") + """Confidence score for this inference.""" + evidence: Optional[List["_models.InferenceEvidence"]] = rest_field() + """The evidence corresponding to the inference value.""" + case_id: Optional[str] = rest_field(name="caseId") + """An identifier for a clinical case, if there are multiple clinical cases regarding the same + patient.""" + + @overload + def __init__( + self, + *, + type: Union[str, "_models.OncoPhenotypeInferenceType"], + value: str, + description: Optional[str] = None, + confidence_score: Optional[float] = None, + evidence: Optional[List["_models.InferenceEvidence"]] = None, + case_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OncoPhenotypeInferenceResult(_model_base.Model): + """The inference results for the Onco Phenotype request. + + All required parameters must be populated in order to send to server. + + :ivar patient_results: Results for the patients given in the request. Required. + :vartype patient_results: + list[~azure.healthinsights.cancerprofiling.models.OncoPhenotypePatientResult] + :ivar model_version: The version of the model used for inference, expressed as the model date. + Required. + :vartype model_version: str + """ + + patient_results: List["_models.OncoPhenotypePatientResult"] = rest_field(name="patientResults") + """Results for the patients given in the request. Required.""" + model_version: str = rest_field(name="modelVersion") + """The version of the model used for inference, expressed as the model date. Required.""" + + @overload + def __init__( + self, + *, + patient_results: List["_models.OncoPhenotypePatientResult"], + model_version: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OncoPhenotypeModelConfiguration(_model_base.Model): + """Configuration affecting the Onco Phenotype model's inference. + + :ivar verbose: An indication whether the model should produce verbose output. + :vartype verbose: bool + :ivar include_evidence: An indication whether the model's output should include evidence for + the inferences. + :vartype include_evidence: bool + :ivar inference_types: A list of inference types to be inferred for the current request. + This could be used if only part of the Onco Phenotype inferences are required. + If this list is omitted or empty, the model will return all the inference types. + :vartype inference_types: list[str or + ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceType] + :ivar check_for_cancer_case: An indication whether to perform a preliminary step on the + patient's documents to determine whether they relate to a Cancer case. + :vartype check_for_cancer_case: bool + """ + + verbose: Optional[bool] = rest_field() + """An indication whether the model should produce verbose output.""" + include_evidence: Optional[bool] = rest_field(name="includeEvidence") + """An indication whether the model's output should include evidence for the inferences.""" + inference_types: Optional[List[Union[str, "_models.OncoPhenotypeInferenceType"]]] = rest_field( + name="inferenceTypes" + ) + """A list of inference types to be inferred for the current request. + This could be used if only part of the Onco Phenotype inferences are required. + If this list is omitted or empty, the model will return all the inference types.""" + check_for_cancer_case: Optional[bool] = rest_field(name="checkForCancerCase") + """An indication whether to perform a preliminary step on the patient's documents to determine + whether they relate to a Cancer case.""" + + @overload + def __init__( + self, + *, + verbose: Optional[bool] = None, + include_evidence: Optional[bool] = None, + inference_types: Optional[List[Union[str, "_models.OncoPhenotypeInferenceType"]]] = None, + check_for_cancer_case: Optional[bool] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OncoPhenotypePatientResult(_model_base.Model): + """The results of the model's work for a single patient. + + All required parameters must be populated in order to send to server. + + :ivar patient_id: The identifier given for the patient in the request. Required. + :vartype patient_id: str + :ivar inferences: The model's inferences for the given patient. Required. + :vartype inferences: list[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInference] + """ + + patient_id: str = rest_field(name="patientId") + """The identifier given for the patient in the request. Required.""" + inferences: List["_models.OncoPhenotypeInference"] = rest_field() + """The model's inferences for the given patient. Required.""" + + @overload + def __init__( + self, + *, + patient_id: str, + inferences: List["_models.OncoPhenotypeInference"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + - :ivar source_type: The type of the content's source. - In case the source type is 'inline', the content is given as a string (for instance, text). - In case the source type is 'reference', the content is given as a URI. Required. Known values - are: "inline" and "reference". - :vartype source_type: str or - ~azure.healthinsights.cancerprofiling.models.DocumentContentSourceType - :ivar value: The content of the document, given either inline (as a string) or as a reference - (URI). Required. - :vartype value: str +class OrderedProcedure(_model_base.Model): + """Procedure information. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.cancerprofiling.models.Extension] + :ivar code: Procedure code. + :vartype code: ~azure.healthinsights.cancerprofiling.models.CodeableConcept + :ivar description: Procedure description. + :vartype description: str """ - source_type: Union[str, "_models.DocumentContentSourceType"] = rest_field(name="sourceType") - """The type of the content's source. In case the source type is 'inline', the content is given as a string (for - instance, text). In case the source type is 'reference', the content is given as a URI. Required. Known values - are: \"inline\" and \"reference\". """ - value: str = rest_field() - """The content of the document, given either inline (as a string) or as a reference (URI). Required. """ + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Procedure code.""" + description: Optional[str] = rest_field() + """Procedure description.""" @overload def __init__( self, *, - source_type: Union[str, "_models.DocumentContentSourceType"], - value: str, + extension: Optional[List["_models.Extension"]] = None, + code: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, ): ... @@ -153,45 +1077,32 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class Error(_model_base.Model): - """The error object. - - All required parameters must be populated in order to send to Azure. +class PatientDetails(_model_base.Model): + """Patient structured information, including demographics and known structured clinical + information. - :ivar code: One of a server-defined set of error codes. Required. - :vartype code: str - :ivar message: A human-readable representation of the error. Required. - :vartype message: str - :ivar target: The target of the error. - :vartype target: str - :ivar details: An array of details about specific errors that led to this reported error. - Required. - :vartype details: list[~azure.healthinsights.cancerprofiling.models.Error] - :ivar innererror: An object containing more specific information than the current object about - the error. - :vartype innererror: ~azure.healthinsights.cancerprofiling.models.InnerError + :ivar sex: The patient's sex. Known values are: "female", "male", and "unspecified". + :vartype sex: str or ~azure.healthinsights.cancerprofiling.models.PatientSex + :ivar birth_date: The patient's date of birth. + :vartype birth_date: ~datetime.date + :ivar clinical_info: Known clinical information for the patient, structured. + :vartype clinical_info: list[~azure.healthinsights.cancerprofiling.models.Resource] """ - code: str = rest_field() - """One of a server-defined set of error codes. Required. """ - message: str = rest_field() - """A human-readable representation of the error. Required. """ - target: Optional[str] = rest_field() - """The target of the error. """ - details: List["_models.Error"] = rest_field() - """An array of details about specific errors that led to this reported error. Required. """ - innererror: Optional["_models.InnerError"] = rest_field() - """An object containing more specific information than the current object about the error. """ + sex: Optional[Union[str, "_models.PatientSex"]] = rest_field() + """The patient's sex. Known values are: \"female\", \"male\", and \"unspecified\".""" + birth_date: Optional[datetime.date] = rest_field(name="birthDate") + """The patient's date of birth.""" + clinical_info: Optional[List["_models.Resource"]] = rest_field(name="clinicalInfo") + """Known clinical information for the patient, structured.""" @overload def __init__( self, *, - code: str, - message: str, - details: List["_models.Error"], - target: Optional[str] = None, - innererror: Optional["_models.InnerError"] = None, + sex: Optional[Union[str, "_models.PatientSex"]] = None, + birth_date: Optional[datetime.date] = None, + clinical_info: Optional[List["_models.Resource"]] = None, ): ... @@ -206,36 +1117,79 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class InferenceEvidence(_model_base.Model): - """A piece of evidence corresponding to an inference. +class PatientDocument(_model_base.Model): + """A clinical document related to a patient. Document here is in the wide sense - not just a text + document (note). - :ivar patient_data_evidence: A piece of evidence from a clinical note (text document). - :vartype patient_data_evidence: - ~azure.healthinsights.cancerprofiling.models.ClinicalNoteEvidence - :ivar patient_info_evidence: A piece of clinical information, expressed as a code in a clinical - coding - system. - :vartype patient_info_evidence: - ~azure.healthinsights.cancerprofiling.models.ClinicalCodedElement - :ivar importance: A value indicating how important this piece of evidence is for the inference. - :vartype importance: float + All required parameters must be populated in order to send to server. + + :ivar type: The type of the patient document, such as 'note' (text document) or 'fhirBundle' + (FHIR JSON document). Required. Known values are: "note", "fhirBundle", "dicom", and + "genomicSequencing". + :vartype type: str or ~azure.healthinsights.cancerprofiling.models.DocumentType + :ivar clinical_type: The type of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", "procedure", "progress", + "laboratory", and "pathologyReport". + :vartype clinical_type: str or + ~azure.healthinsights.cancerprofiling.models.ClinicalDocumentType + :ivar id: A given identifier for the document. Has to be unique across all documents for a + single patient. Required. + :vartype id: str + :ivar language: A 2 letter ISO 639-1 representation of the language of the document. + :vartype language: str + :ivar created_date_time: The date and time when the document was created. + :vartype created_date_time: ~datetime.datetime + :ivar authors: Document author(s). + :vartype authors: list[~azure.healthinsights.cancerprofiling.models.DocumentAuthor] + :ivar specialty_type: specialty type the document. Known values are: "pathology" and + "radiology". + :vartype specialty_type: str or ~azure.healthinsights.cancerprofiling.models.SpecialtyType + :ivar administrative_metadata: Administrative metadata for the document. + :vartype administrative_metadata: + ~azure.healthinsights.cancerprofiling.models.DocumentAdministrativeMetadata + :ivar content: The content of the patient document. Required. + :vartype content: ~azure.healthinsights.cancerprofiling.models.DocumentContent """ - patient_data_evidence: Optional["_models.ClinicalNoteEvidence"] = rest_field(name="patientDataEvidence") - """A piece of evidence from a clinical note (text document). """ - patient_info_evidence: Optional["_models.ClinicalCodedElement"] = rest_field(name="patientInfoEvidence") - """A piece of clinical information, expressed as a code in a clinical coding -system. """ - importance: Optional[float] = rest_field() - """A value indicating how important this piece of evidence is for the inference. """ + type: Union[str, "_models.DocumentType"] = rest_field() + """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON + document). Required. Known values are: \"note\", \"fhirBundle\", \"dicom\", and + \"genomicSequencing\".""" + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = rest_field(name="clinicalType") + """The type of the clinical document. Known values are: \"consultation\", \"dischargeSummary\", + \"historyAndPhysical\", \"radiologyReport\", \"procedure\", \"progress\", \"laboratory\", and + \"pathologyReport\".""" + id: str = rest_field() + """A given identifier for the document. Has to be unique across all documents for a single + patient. Required.""" + language: Optional[str] = rest_field() + """A 2 letter ISO 639-1 representation of the language of the document.""" + created_date_time: Optional[datetime.datetime] = rest_field(name="createdDateTime", format="rfc3339") + """The date and time when the document was created.""" + authors: Optional[List["_models.DocumentAuthor"]] = rest_field() + """Document author(s).""" + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = rest_field(name="specialtyType") + """specialty type the document. Known values are: \"pathology\" and \"radiology\".""" + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = rest_field( + name="administrativeMetadata" + ) + """Administrative metadata for the document.""" + content: "_models.DocumentContent" = rest_field() + """The content of the patient document. Required.""" @overload def __init__( self, *, - patient_data_evidence: Optional["_models.ClinicalNoteEvidence"] = None, - patient_info_evidence: Optional["_models.ClinicalCodedElement"] = None, - importance: Optional[float] = None, + type: Union[str, "_models.DocumentType"], + id: str, # pylint: disable=redefined-builtin + content: "_models.DocumentContent", + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = None, + language: Optional[str] = None, + created_date_time: Optional[datetime.datetime] = None, + authors: Optional[List["_models.DocumentAuthor"]] = None, + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = None, + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = None, ): ... @@ -250,30 +1204,42 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class InnerError(_model_base.Model): - """An object containing more specific information about the error. As per Microsoft One API - guidelines - - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. +class PatientRecord(_model_base.Model): + """A patient record, including their clinical information and data. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. - :ivar code: One of a server-defined set of error codes. Required. - :vartype code: str - :ivar innererror: Inner error. - :vartype innererror: ~azure.healthinsights.cancerprofiling.models.InnerError + :ivar id: A given identifier for the patient. Has to be unique across all patients in a single + request. Required. + :vartype id: str + :ivar info: Patient structured information, including demographics and known structured + clinical information. + :vartype info: ~azure.healthinsights.cancerprofiling.models.PatientDetails + :ivar encounters: Patient encounters/visits. + :vartype encounters: list[~azure.healthinsights.cancerprofiling.models.Encounter] + :ivar patient_documents: Patient unstructured clinical data, given as documents. + :vartype patient_documents: list[~azure.healthinsights.cancerprofiling.models.PatientDocument] """ - code: str = rest_field() - """One of a server-defined set of error codes. Required. """ - innererror: Optional["_models.InnerError"] = rest_field() - """Inner error. """ + id: str = rest_field() + """A given identifier for the patient. Has to be unique across all patients in a single request. + Required.""" + info: Optional["_models.PatientDetails"] = rest_field() + """Patient structured information, including demographics and known structured clinical + information.""" + encounters: Optional[List["_models.Encounter"]] = rest_field() + """Patient encounters/visits.""" + patient_documents: Optional[List["_models.PatientDocument"]] = rest_field(name="patientDocuments") + """Patient unstructured clinical data, given as documents.""" @overload def __init__( self, *, - code: str, - innererror: Optional["_models.InnerError"] = None, + id: str, # pylint: disable=redefined-builtin + info: Optional["_models.PatientDetails"] = None, + encounters: Optional[List["_models.Encounter"]] = None, + patient_documents: Optional[List["_models.PatientDocument"]] = None, ): ... @@ -288,29 +1254,27 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class OncoPhenotypeData(_model_base.Model): - """OncoPhenotypeData. - - All required parameters must be populated in order to send to Azure. +class Period(Element): + """A time period defined by a start and end date and optionally time + Based on `FHIR Period `_. - :ivar patients: The list of patients, including their clinical information and data. Required. - :vartype patients: list[~azure.healthinsights.cancerprofiling.models.PatientRecord] - :ivar configuration: Configuration affecting the Onco Phenotype model's inference. - :vartype configuration: - ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeModelConfiguration + :ivar start: Starting time with inclusive boundary. + :vartype start: str + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: str """ - patients: List["_models.PatientRecord"] = rest_field() - """The list of patients, including their clinical information and data. Required. """ - configuration: Optional["_models.OncoPhenotypeModelConfiguration"] = rest_field() - """Configuration affecting the Onco Phenotype model's inference. """ + start: Optional[str] = rest_field() + """Starting time with inclusive boundary.""" + end: Optional[str] = rest_field() + """End time with inclusive boundary, if not ongoing.""" @overload def __init__( self, *, - patients: List["_models.PatientRecord"], - configuration: Optional["_models.OncoPhenotypeModelConfiguration"] = None, + start: Optional[str] = None, + end: Optional[str] = None, ): ... @@ -325,53 +1289,42 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class OncoPhenotypeInference(_model_base.Model): - """An inference made by the Onco Phenotype model regarding a patient. +class Quantity(Element): + """A measured or measurable amount + Based on `FHIR Quantity `_. - All required parameters must be populated in order to send to Azure. - - :ivar type: The type of the Onco Phenotype inference. Required. Known values are: "tumorSite", - "histology", "clinicalStageT", "clinicalStageN", "clinicalStageM", "pathologicStageT", - "pathologicStageN", and "pathologicStageM". - :vartype type: str or ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceType - :ivar value: The value of the inference, as relevant for the given inference type. Required. - :vartype value: str - :ivar description: The description corresponding to the inference value. - :vartype description: str - :ivar confidence_score: Confidence score for this inference. - :vartype confidence_score: float - :ivar evidence: The evidence corresponding to the inference value. - :vartype evidence: list[~azure.healthinsights.cancerprofiling.models.InferenceEvidence] - :ivar case_id: An identifier for a clinical case, if there are multiple clinical cases - regarding the same patient. - :vartype case_id: str + :ivar value: Numerical value (with implicit precision). + :vartype value: float + :ivar comparator: < | <= | >= | > - how to understand the value. + :vartype comparator: str + :ivar unit: Unit representation. + :vartype unit: str + :ivar system: System that defines coded unit form. + :vartype system: str + :ivar code: Coded form of the unit. + :vartype code: str """ - type: Union[str, "_models.OncoPhenotypeInferenceType"] = rest_field() # pylint: disable=redefined-builtin - """The type of the Onco Phenotype inference. Required. Known values are: \"tumorSite\", \"histology\", - \"clinicalStageT\", \"clinicalStageN\", \"clinicalStageM\", \"pathologicStageT\", \"pathologicStageN\", - and \"pathologicStageM\". """ - value: str = rest_field() - """The value of the inference, as relevant for the given inference type. Required. """ - description: Optional[str] = rest_field() - """The description corresponding to the inference value. """ - confidence_score: Optional[float] = rest_field(name="confidenceScore") - """Confidence score for this inference. """ - evidence: Optional[List["_models.InferenceEvidence"]] = rest_field() - """The evidence corresponding to the inference value. """ - case_id: Optional[str] = rest_field(name="caseId") - """An identifier for a clinical case, if there are multiple clinical cases regarding the same patient. """ + value: Optional[float] = rest_field() + """Numerical value (with implicit precision).""" + comparator: Optional[str] = rest_field() + """< | <= | >= | > - how to understand the value.""" + unit: Optional[str] = rest_field() + """Unit representation.""" + system: Optional[str] = rest_field() + """System that defines coded unit form.""" + code: Optional[str] = rest_field() + """Coded form of the unit.""" @overload def __init__( self, *, - type: Union[str, "_models.OncoPhenotypeInferenceType"], # pylint: disable=redefined-builtin - value: str, - description: Optional[str] = None, - confidence_score: Optional[float] = None, - evidence: Optional[List["_models.InferenceEvidence"]] = None, - case_id: Optional[str] = None, + value: Optional[float] = None, + comparator: Optional[str] = None, + unit: Optional[str] = None, + system: Optional[str] = None, + code: Optional[str] = None, ): ... @@ -386,46 +1339,27 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class OncoPhenotypeModelConfiguration(_model_base.Model): - """Configuration affecting the Onco Phenotype model's inference. +class Range(Element): + """A set of ordered Quantities defined by a low and high limit + Based on `FHIR Range `_. - :ivar verbose: An indication whether the model should produce verbose output. - :vartype verbose: bool - :ivar include_evidence: An indication whether the model's output should include evidence for - the inferences. - :vartype include_evidence: bool - :ivar inference_types: A list of inference types to be inferred for the current request. - This could be used if only part of the Onco Phenotype inferences are required. - If this list is omitted or empty, the model will return all the inference types. - :vartype inference_types: list[str or - ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInferenceType] - :ivar check_for_cancer_case: An indication whether to perform a preliminary step on the - patient's documents to determine whether they relate to a Cancer case. - :vartype check_for_cancer_case: bool + :ivar low: Low limit. + :vartype low: ~azure.healthinsights.cancerprofiling.models.Quantity + :ivar high: High limit. + :vartype high: ~azure.healthinsights.cancerprofiling.models.Quantity """ - verbose: bool = rest_field(default=False) - """An indication whether the model should produce verbose output. """ - include_evidence: bool = rest_field(name="includeEvidence", default=True) - """An indication whether the model's output should include evidence for the inferences. """ - inference_types: Optional[List[Union[str, "_models.OncoPhenotypeInferenceType"]]] = rest_field( - name="inferenceTypes" - ) - """A list of inference types to be inferred for the current request. -This could be used if only part of the Onco Phenotype inferences are required. -If this list is omitted or empty, the model will return all the inference types. """ - check_for_cancer_case: bool = rest_field(name="checkForCancerCase", default=False) - """An indication whether to perform a preliminary step on the patient's documents to determine whether they - relate to a Cancer case. """ + low: Optional["_models.Quantity"] = rest_field() + """Low limit.""" + high: Optional["_models.Quantity"] = rest_field() + """High limit.""" @overload def __init__( self, *, - verbose: bool = False, - include_evidence: bool = True, - inference_types: Optional[List[Union[str, "_models.OncoPhenotypeInferenceType"]]] = None, - check_for_cancer_case: bool = False, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, ): ... @@ -440,28 +1374,27 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class OncoPhenotypePatientResult(_model_base.Model): - """The results of the model's work for a single patient. - - All required parameters must be populated in order to send to Azure. +class Ratio(Element): + """A ratio of two Quantity values - a numerator and a denominator + Based on `FHIR Ratio `_. - :ivar id: The identifier given for the patient in the request. Required. - :vartype id: str - :ivar inferences: The model's inferences for the given patient. Required. - :vartype inferences: list[~azure.healthinsights.cancerprofiling.models.OncoPhenotypeInference] + :ivar numerator: Numerator value. + :vartype numerator: ~azure.healthinsights.cancerprofiling.models.Quantity + :ivar denominator: Denominator value. + :vartype denominator: ~azure.healthinsights.cancerprofiling.models.Quantity """ - id: str = rest_field() - """The identifier given for the patient in the request. Required. """ - inferences: List["_models.OncoPhenotypeInference"] = rest_field() - """The model's inferences for the given patient. Required. """ + numerator: Optional["_models.Quantity"] = rest_field() + """Numerator value.""" + denominator: Optional["_models.Quantity"] = rest_field() + """Denominator value.""" @overload def __init__( self, *, - id: str, # pylint: disable=redefined-builtin - inferences: List["_models.OncoPhenotypeInference"], + numerator: Optional["_models.Quantity"] = None, + denominator: Optional["_models.Quantity"] = None, ): ... @@ -476,73 +1409,37 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class OncoPhenotypeResult(_model_base.Model): - """The response for the Onco Phenotype request. - - Readonly variables are only populated by the server, and will be ignored when sending a request. - - All required parameters must be populated in order to send to Azure. - - :ivar job_id: A processing job identifier. Required. - :vartype job_id: str - :ivar created_date_time: The date and time when the processing job was created. Required. - :vartype created_date_time: ~datetime.datetime - :ivar expiration_date_time: The date and time when the processing job is set to expire. - Required. - :vartype expiration_date_time: ~datetime.datetime - :ivar last_update_date_time: The date and time when the processing job was last updated. - Required. - :vartype last_update_date_time: ~datetime.datetime - :ivar status: The status of the processing job. Required. Known values are: "notStarted", - "running", "succeeded", "failed", and "partiallyCompleted". - :vartype status: str or ~azure.healthinsights.cancerprofiling.models.JobStatus - :ivar errors: An array of errors, if any errors occurred during the processing job. - :vartype errors: list[~azure.healthinsights.cancerprofiling.models.Error] - :ivar results: The inference results for the Onco Phenotype request. - :vartype results: ~azure.healthinsights.cancerprofiling.models.OncoPhenotypeResults - """ - - job_id: str = rest_field(name="jobId", readonly=True) - """A processing job identifier. Required. """ - created_date_time: datetime.datetime = rest_field(name="createdDateTime", readonly=True) - """The date and time when the processing job was created. Required. """ - expiration_date_time: datetime.datetime = rest_field(name="expirationDateTime", readonly=True) - """The date and time when the processing job is set to expire. Required. """ - last_update_date_time: datetime.datetime = rest_field(name="lastUpdateDateTime", readonly=True) - """The date and time when the processing job was last updated. Required. """ - status: Union[str, "_models.JobStatus"] = rest_field(readonly=True) - """The status of the processing job. Required. Known values are: \"notStarted\", \"running\", \"succeeded\", - \"failed\", and \"partiallyCompleted\". """ - errors: Optional[List["_models.Error"]] = rest_field(readonly=True) - """An array of errors, if any errors occurred during the processing job. """ - results: Optional["_models.OncoPhenotypeResults"] = rest_field(readonly=True) - """The inference results for the Onco Phenotype request. """ - - -class OncoPhenotypeResults(_model_base.Model): - """The inference results for the Onco Phenotype request. +class Reference(Element): + """A reference from one resource to another + Based on `FHIR Reference `_. - All required parameters must be populated in order to send to Azure. - - :ivar patients: Results for the patients given in the request. Required. - :vartype patients: - list[~azure.healthinsights.cancerprofiling.models.OncoPhenotypePatientResult] - :ivar model_version: The version of the model used for inference, expressed as the model date. - Required. - :vartype model_version: str + :ivar reference: Literal reference, Relative, internal or absolute URL. + :vartype reference: str + :ivar type: Type the reference refers to (e.g. "Patient"). + :vartype type: str + :ivar identifier: Logical reference, when literal reference is not known. + :vartype identifier: ~azure.healthinsights.cancerprofiling.models.Identifier + :ivar display: Text alternative for the resource. + :vartype display: str """ - patients: List["_models.OncoPhenotypePatientResult"] = rest_field() - """Results for the patients given in the request. Required. """ - model_version: str = rest_field(name="modelVersion") - """The version of the model used for inference, expressed as the model date. Required. """ + reference: Optional[str] = rest_field() + """Literal reference, Relative, internal or absolute URL.""" + type: Optional[str] = rest_field() + """Type the reference refers to (e.g. \"Patient\").""" + identifier: Optional["_models.Identifier"] = rest_field() + """Logical reference, when literal reference is not known.""" + display: Optional[str] = rest_field() + """Text alternative for the resource.""" @overload def __init__( self, *, - patients: List["_models.OncoPhenotypePatientResult"], - model_version: str, + reference: Optional[str] = None, + type: Optional[str] = None, + identifier: Optional["_models.Identifier"] = None, + display: Optional[str] = None, ): ... @@ -557,57 +1454,45 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class PatientDocument(_model_base.Model): - """A clinical document related to a patient. Document here is in the wide sense - not just a text - document (note). +class Resource(_model_base.Model): + """Resource is the ancestor of DomainResource from which most resources are derived. Bundle, + Parameters, and Binary extend Resource directly. + Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. - :ivar type: The type of the patient document, such as 'note' (text document) or 'fhirBundle' - (FHIR JSON document). Required. Known values are: "note", "fhirBundle", "dicom", and - "genomicSequencing". - :vartype type: str or ~azure.healthinsights.cancerprofiling.models.DocumentType - :ivar clinical_type: The type of the clinical document. Known values are: "consultation", - "dischargeSummary", "historyAndPhysical", "procedure", "progress", "imaging", "laboratory", and - "pathology". - :vartype clinical_type: str or - ~azure.healthinsights.cancerprofiling.models.ClinicalDocumentType - :ivar id: A given identifier for the document. Has to be unique across all documents for a - single patient. Required. + :ivar resource_type: The type of resource. Required. + :vartype resource_type: str + :ivar id: Resource Id. :vartype id: str - :ivar language: A 2 letter ISO 639-1 representation of the language of the document. + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.cancerprofiling.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. :vartype language: str - :ivar created_date_time: The date and time when the document was created. - :vartype created_date_time: ~datetime.datetime - :ivar content: The content of the patient document. Required. - :vartype content: ~azure.healthinsights.cancerprofiling.models.DocumentContent """ - type: Union[str, "_models.DocumentType"] = rest_field() # pylint: disable=redefined-builtin - """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document). - Required. Known values are: \"note\", \"fhirBundle\", \"dicom\", and \"genomicSequencing\". """ - clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = rest_field(name="clinicalType") - """The type of the clinical document. Known values are: \"consultation\", \"dischargeSummary\", - \"historyAndPhysical\", \"procedure\", \"progress\", \"imaging\", \"laboratory\", and \"pathology\". """ - id: str = rest_field() - """A given identifier for the document. Has to be unique across all documents for a single patient. Required. """ + resource_type: str = rest_field(name="resourceType") + """The type of resource. Required.""" + id: Optional[str] = rest_field() + """Resource Id.""" + meta: Optional["_models.Meta"] = rest_field() + """Metadata about the resource.""" + implicit_rules: Optional[str] = rest_field(name="implicitRules") + """A set of rules under which this content was created.""" language: Optional[str] = rest_field() - """A 2 letter ISO 639-1 representation of the language of the document. """ - created_date_time: Optional[datetime.datetime] = rest_field(name="createdDateTime") - """The date and time when the document was created. """ - content: "_models.DocumentContent" = rest_field() - """The content of the patient document. Required. """ + """Language of the resource content.""" @overload def __init__( self, *, - type: Union[str, "_models.DocumentType"], # pylint: disable=redefined-builtin - id: str, # pylint: disable=redefined-builtin - content: "_models.DocumentContent", - clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = None, + resource_type: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, language: Optional[str] = None, - created_date_time: Optional[datetime.datetime] = None, ): ... @@ -622,32 +1507,54 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class PatientInfo(_model_base.Model): - """Patient structured information, including demographics and known structured clinical - information. - - :ivar sex: The patient's sex. Known values are: "female", "male", and "unspecified". - :vartype sex: str or ~azure.healthinsights.cancerprofiling.models.PatientInfoSex - :ivar birth_date: The patient's date of birth. - :vartype birth_date: ~datetime.date - :ivar clinical_info: Known clinical information for the patient, structured. - :vartype clinical_info: list[~azure.healthinsights.cancerprofiling.models.ClinicalCodedElement] +class SampledData(Element): + """A series of measurements taken by a device + Based on `FHIR SampledData `_. + + All required parameters must be populated in order to send to server. + + :ivar origin: Zero value and units. Required. + :vartype origin: ~azure.healthinsights.cancerprofiling.models.Quantity + :ivar period: Number of milliseconds between samples. Required. + :vartype period: float + :ivar factor: Multiply data by this before adding to origin. + :vartype factor: float + :ivar lower_limit: Lower limit of detection. + :vartype lower_limit: float + :ivar upper_limit: Upper limit of detection. + :vartype upper_limit: float + :ivar dimensions: Number of sample points at each time point. Required. + :vartype dimensions: int + :ivar data: Decimal values with spaces, or "E" | "U" | "L". + :vartype data: str """ - sex: Optional[Union[str, "_models.PatientInfoSex"]] = rest_field() - """The patient's sex. Known values are: \"female\", \"male\", and \"unspecified\".""" - birth_date: Optional[datetime.date] = rest_field(name="birthDate") - """The patient's date of birth. """ - clinical_info: Optional[List["_models.ClinicalCodedElement"]] = rest_field(name="clinicalInfo") - """Known clinical information for the patient, structured. """ + origin: "_models.Quantity" = rest_field() + """Zero value and units. Required.""" + period: float = rest_field() + """Number of milliseconds between samples. Required.""" + factor: Optional[float] = rest_field() + """Multiply data by this before adding to origin.""" + lower_limit: Optional[float] = rest_field(name="lowerLimit") + """Lower limit of detection.""" + upper_limit: Optional[float] = rest_field(name="upperLimit") + """Upper limit of detection.""" + dimensions: int = rest_field() + """Number of sample points at each time point. Required.""" + data: Optional[str] = rest_field() + """Decimal values with spaces, or \"E\" | \"U\" | \"L\".""" @overload def __init__( self, *, - sex: Optional[Union[str, "_models.PatientInfoSex"]] = None, - birth_date: Optional[datetime.date] = None, - clinical_info: Optional[List["_models.ClinicalCodedElement"]] = None, + origin: "_models.Quantity", + period: float, + dimensions: int, + factor: Optional[float] = None, + lower_limit: Optional[float] = None, + upper_limit: Optional[float] = None, + data: Optional[str] = None, ): ... @@ -662,35 +1569,26 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class PatientRecord(_model_base.Model): - """A patient record, including their clinical information and data. - - All required parameters must be populated in order to send to Azure. +class TimePeriod(_model_base.Model): + """A duration of time during which an event is happening. - :ivar id: A given identifier for the patient. Has to be unique across all patients in a single - request. Required. - :vartype id: str - :ivar info: Patient structured information, including demographics and known structured - clinical information. - :vartype info: ~azure.healthinsights.cancerprofiling.models.PatientInfo - :ivar data: Patient unstructured clinical data, given as documents. - :vartype data: list[~azure.healthinsights.cancerprofiling.models.PatientDocument] + :ivar start: Starting time with inclusive boundary. + :vartype start: ~datetime.datetime + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: ~datetime.datetime """ - id: str = rest_field() - """A given identifier for the patient. Has to be unique across all patients in a single request. Required. """ - info: Optional["_models.PatientInfo"] = rest_field() - """Patient structured information, including demographics and known structured clinical information. """ - data: Optional[List["_models.PatientDocument"]] = rest_field() - """Patient unstructured clinical data, given as documents. """ + start: Optional[datetime.datetime] = rest_field(format="rfc3339") + """Starting time with inclusive boundary.""" + end: Optional[datetime.datetime] = rest_field(format="rfc3339") + """End time with inclusive boundary, if not ongoing.""" @overload def __init__( self, *, - id: str, # pylint: disable=redefined-builtin - info: Optional["_models.PatientInfo"] = None, - data: Optional[List["_models.PatientDocument"]] = None, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, ): ... diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/async_samples/sample_infer_cancer_profiling_async.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/async_samples/sample_infer_cancer_profiling_async.py index c8724d108f71..e18cb52796e7 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/async_samples/sample_infer_cancer_profiling_async.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/async_samples/sample_infer_cancer_profiling_async.py @@ -37,8 +37,7 @@ async def infer_cancer_profiling_async(self) -> None: # Create an Onco Phenotype client # - cancer_profiling_client = CancerProfilingClient(endpoint=ENDPOINT, - credential=AzureKeyCredential(KEY)) + cancer_profiling_client = CancerProfilingClient(endpoint=ENDPOINT, credential=AzureKeyCredential(KEY)) # # Construct patient @@ -70,14 +69,14 @@ async def infer_cancer_profiling_async(self) -> None: Findings are suggestive of a working diagnosis of pneumonia. The patient is referred to a follow-up CXR in 2 weeks.""" - patient_document1 = models.PatientDocument(type=models.DocumentType.NOTE, - id="doc1", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=doc_content1), - clinical_type=models.ClinicalDocumentType.IMAGING, - language="en", - created_date_time=datetime.datetime(2021, 8, 15)) + patient_document1 = models.PatientDocument( + type=models.DocumentType.NOTE, + id="doc1", + content=models.DocumentContent(source_type=models.DocumentContentSourceType.INLINE, value=doc_content1), + clinical_type=models.ClinicalDocumentType.IMAGING, + language="en", + created_date_time=datetime.datetime(2021, 8, 15), + ) doc_content2 = """ Oncology Clinic @@ -107,14 +106,14 @@ async def infer_cancer_profiling_async(self) -> None: Could benefit from biological therapy. Different treatment options were explained- the patient wants to get a second opinion.""" - patient_document2 = models.PatientDocument(type=models.DocumentType.NOTE, - id="doc2", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=doc_content2), - clinical_type=models.ClinicalDocumentType.PATHOLOGY, - language="en", - created_date_time=datetime.datetime(2021, 10, 20)) + patient_document2 = models.PatientDocument( + type=models.DocumentType.NOTE, + id="doc2", + content=models.DocumentContent(source_type=models.DocumentContentSourceType.INLINE, value=doc_content2), + clinical_type=models.ClinicalDocumentType.PATHOLOGY, + language="en", + created_date_time=datetime.datetime(2021, 10, 20), + ) doc_content3 = """ PATHOLOGY REPORT @@ -138,14 +137,14 @@ async def infer_cancer_profiling_async(self) -> None: Blocks with invasive carcinoma: A1 Special studies: Pending""" - patient_document3 = models.PatientDocument(type=models.DocumentType.NOTE, - id="doc3", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=doc_content3), - clinical_type=models.ClinicalDocumentType.PATHOLOGY, - language="en", - created_date_time=datetime.datetime(2022, 1, 1)) + patient_document3 = models.PatientDocument( + type=models.DocumentType.NOTE, + id="doc3", + content=models.DocumentContent(source_type=models.DocumentContentSourceType.INLINE, value=doc_content3), + clinical_type=models.ClinicalDocumentType.PATHOLOGY, + language="en", + created_date_time=datetime.datetime(2022, 1, 1), + ) patient_doc_list = [patient_document1, patient_document2, patient_document3] patient1.data = patient_doc_list @@ -176,12 +175,14 @@ def print_inferences(cancer_profiling_result): for inference in patient_result.inferences: print( f"\n=== Clinical Type: {str(inference.type)} Value: {inference.value}\ - ConfidenceScore: {inference.confidence_score} ===") + ConfidenceScore: {inference.confidence_score} ===" + ) for evidence in inference.evidence: data_evidence = evidence.patient_data_evidence print( f"Evidence {data_evidence.id} {data_evidence.offset} {data_evidence.length}\ - {data_evidence.text}") + {data_evidence.text}" + ) else: errors = cancer_profiling_result.errors if errors is not None: diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/sample_infer_cancer_profiling.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/sample_infer_cancer_profiling.py index 27c38ade5906..83e7f0b8deb5 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/sample_infer_cancer_profiling.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/samples/sample_infer_cancer_profiling.py @@ -67,14 +67,14 @@ def infer_cancer_profiling(self) -> None: Findings are suggestive of a working diagnosis of pneumonia. The patient is referred to a follow-up CXR in 2 weeks.""" - patient_document1 = models.PatientDocument(type=models.DocumentType.NOTE, - id="doc1", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=doc_content1), - clinical_type=models.ClinicalDocumentType.IMAGING, - language="en", - created_date_time=datetime.datetime(2021, 8, 15)) + patient_document1 = models.PatientDocument( + type=models.DocumentType.NOTE, + id="doc1", + content=models.DocumentContent(source_type=models.DocumentContentSourceType.INLINE, value=doc_content1), + clinical_type=models.ClinicalDocumentType.IMAGING, + language="en", + created_date_time=datetime.datetime(2021, 8, 15), + ) doc_content2 = """ Oncology Clinic @@ -104,14 +104,14 @@ def infer_cancer_profiling(self) -> None: Could benefit from biological therapy. Different treatment options were explained- the patient wants to get a second opinion.""" - patient_document2 = models.PatientDocument(type=models.DocumentType.NOTE, - id="doc2", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=doc_content2), - clinical_type=models.ClinicalDocumentType.PATHOLOGY, - language="en", - created_date_time=datetime.datetime(2021, 10, 20)) + patient_document2 = models.PatientDocument( + type=models.DocumentType.NOTE, + id="doc2", + content=models.DocumentContent(source_type=models.DocumentContentSourceType.INLINE, value=doc_content2), + clinical_type=models.ClinicalDocumentType.PATHOLOGY, + language="en", + created_date_time=datetime.datetime(2021, 10, 20), + ) doc_content3 = """ PATHOLOGY REPORT @@ -135,14 +135,14 @@ def infer_cancer_profiling(self) -> None: Blocks with invasive carcinoma: A1 Special studies: Pending""" - patient_document3 = models.PatientDocument(type=models.DocumentType.NOTE, - id="doc3", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=doc_content3), - clinical_type=models.ClinicalDocumentType.PATHOLOGY, - language="en", - created_date_time=datetime.datetime(2022, 1, 1)) + patient_document3 = models.PatientDocument( + type=models.DocumentType.NOTE, + id="doc3", + content=models.DocumentContent(source_type=models.DocumentContentSourceType.INLINE, value=doc_content3), + clinical_type=models.ClinicalDocumentType.PATHOLOGY, + language="en", + created_date_time=datetime.datetime(2022, 1, 1), + ) patient_doc_list = [patient_document1, patient_document2, patient_document3] patient1.data = patient_doc_list diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/setup.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/setup.py index 661aee6d571a..212d811ca432 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/setup.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/setup.py @@ -13,7 +13,7 @@ PACKAGE_NAME = "azure-healthinsights-cancerprofiling" -PACKAGE_PPRINT_NAME = "Cognitive Services Health Insights Cancer Profilings" +PACKAGE_PPRINT_NAME = "Azure Health Insights - Cancer Profiling" # a-b-c => a/b/c package_folder_path = PACKAGE_NAME.replace("-", "/") @@ -29,7 +29,7 @@ setup( name=PACKAGE_NAME, version=version, - description='Microsoft {} Client Library for Python'.format(PACKAGE_PPRINT_NAME), + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), long_description=open("README.md", "r").read(), long_description_content_type="text/markdown", license="MIT License", @@ -42,11 +42,11 @@ "Programming Language :: Python", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "License :: OSI Approved :: MIT License", ], zip_safe=False, @@ -60,12 +60,12 @@ ), include_package_data=True, package_data={ - "pytyped": ["py.typed"], + "azure.healthinsights.cancerprofiling": ["py.typed"], }, install_requires=[ "isodate<1.0.0,>=0.6.1", - "azure-core<2.0.0,>=1.24.0", - "typing-extensions>=4.3.0; python_version<'3.8.0'", + "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", ], - python_requires=">=3.7", + python_requires=">=3.8", ) diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/conftest.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/conftest.py index ce09206dd299..1c59fd964e90 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/conftest.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/conftest.py @@ -47,6 +47,4 @@ def add_sanitizers(test_proxy): add_general_regex_sanitizer( regex=healthinsights_endpoint, value="https://fake_ad_resource.cognitiveservices.azure.com/" ) - add_general_regex_sanitizer( - regex=healthinsights_key, value="00000000000000000000000000000000" - ) + add_general_regex_sanitizer(regex=healthinsights_key, value="00000000000000000000000000000000") diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/test_cancer_profiling.py b/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/test_cancer_profiling.py index 27aefb6357e1..72aaebee9868 100644 --- a/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/test_cancer_profiling.py +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/tests/test_cancer_profiling.py @@ -20,7 +20,6 @@ class TestCancerProfiling(AzureRecordedTestCase): - @HealthInsightsEnvPreparer() @recorded_by_proxy def test_cancer_profiling(self, healthinsights_endpoint, healthinsights_key): @@ -29,34 +28,28 @@ def test_cancer_profiling(self, healthinsights_endpoint, healthinsights_key): assert cancer_profiling_client is not None data = { - "configuration": { - "checkForCancerCase": True, - "verbose": False, - "includeEvidence": True - }, - "patients": [ - { - "id": "patient1", - "data": [ + "configuration": {"checkForCancerCase": True, "verbose": False, "includeEvidence": True}, + "patients": [ { - "kind": "note", - "clinicalType": "pathology", - "id": "document1", - "language": "en", - "createdDateTime": "2022-01-01T00:00:00", - "content": { - "sourceType": "inline", - "value": "Laterality: Left \n Tumor type present: Invasive duct carcinoma; duct carcinoma in situ \n Tumor site: Upper inner quadrant \n Invasive carcinoma \n Histologic type: Ductal \n Size of invasive component: 0.9 cm \n Histologic Grade - Nottingham combined histologic score: 1 out of 3 \n In situ carcinoma (DCIS) \n Histologic type of DCIS: Cribriform and solid \n Necrosis in DCIS: Yes \n DCIS component of invasive carcinoma: Extensive \n" - } + "id": "patient1", + "data": [ + { + "kind": "note", + "clinicalType": "pathology", + "id": "document1", + "language": "en", + "createdDateTime": "2022-01-01T00:00:00", + "content": { + "sourceType": "inline", + "value": "Laterality: Left \n Tumor type present: Invasive duct carcinoma; duct carcinoma in situ \n Tumor site: Upper inner quadrant \n Invasive carcinoma \n Histologic type: Ductal \n Size of invasive component: 0.9 cm \n Histologic Grade - Nottingham combined histologic score: 1 out of 3 \n In situ carcinoma (DCIS) \n Histologic type of DCIS: Cribriform and solid \n Necrosis in DCIS: Yes \n DCIS component of invasive carcinoma: Extensive \n", + }, + } + ], } - ] - } - ] + ], } poller = cancer_profiling_client.begin_infer_cancer_profile(data) results = poller.result() assert len(results.results.patients[0].inferences) is not 0 - - diff --git a/sdk/healthinsights/azure-healthinsights-cancerprofiling/tsp-location.yaml b/sdk/healthinsights/azure-healthinsights-cancerprofiling/tsp-location.yaml new file mode 100644 index 000000000000..d0cd6c9d5a27 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-cancerprofiling/tsp-location.yaml @@ -0,0 +1,7 @@ +directory: specification/ai/HealthInsights/HealthInsights.OncoPhenotype +commit: 70a4ccdd2be61ae5bc524250c70270b0f4f2b540 +additionalDirectories: +- specification/ai/HealthInsights/HealthInsights.Common/ +- specification/ai/HealthInsights/HealthInsights.OpenAPI/ +repo: Azure/azure-rest-api-specs + diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/_meta.json b/sdk/healthinsights/azure-healthinsights-clinicalmatching/_meta.json new file mode 100644 index 000000000000..6b38b8fc2166 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "70a4ccdd2be61ae5bc524250c70270b0f4f2b540", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/ai/HealthInsights/HealthInsights.TrialMatcher", + "@azure-tools/typespec-python": "0.21.0" +} \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_client.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_client.py index ae3c44691fb8..3aa3ce5d4c59 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_client.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_client.py @@ -11,6 +11,7 @@ from azure.core import PipelineClient from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies from azure.core.rest import HttpRequest, HttpResponse from ._configuration import ClinicalMatchingClientConfiguration @@ -29,7 +30,7 @@ class ClinicalMatchingClient( :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str :keyword int polling_interval: Default waiting time between two polls for LRO operations if no @@ -37,15 +38,32 @@ class ClinicalMatchingClient( """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - _endpoint = "{endpoint}/healthinsights" + _endpoint = "{endpoint}/health-insights" self._config = ClinicalMatchingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - self._client: PipelineClient = PipelineClient(base_url=_endpoint, config=self._config, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) self._serialize = Serializer() self._deserialize = Deserializer() self._serialize.client_side_validation = False - def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -69,7 +87,7 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore def close(self) -> None: self._client.close() diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_configuration.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_configuration.py index d0c367f193a9..21622ce1ab5c 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_configuration.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_configuration.py @@ -6,22 +6,15 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import sys from typing import Any -from azure.core.configuration import Configuration from azure.core.credentials import AzureKeyCredential from azure.core.pipeline import policies from ._version import VERSION -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - -class ClinicalMatchingClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes +class ClinicalMatchingClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long """Configuration for ClinicalMatchingClient. Note that all parameters used to create this instance are saved as instance @@ -33,14 +26,13 @@ class ClinicalMatchingClientConfiguration(Configuration): # pylint: disable=too :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - super(ClinicalMatchingClientConfiguration, self).__init__(**kwargs) - api_version: Literal["2023-03-01-preview"] = kwargs.pop("api_version", "2023-03-01-preview") + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -51,6 +43,7 @@ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) self.credential = credential self.api_version = api_version kwargs.setdefault("sdk_moniker", "healthinsights-clinicalmatching/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -59,9 +52,9 @@ def _configure(self, **kwargs: Any) -> None: self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) - self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) self.authentication_policy = kwargs.get("authentication_policy") if self.credential and not self.authentication_policy: self.authentication_policy = policies.AzureKeyCredentialPolicy( diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_model_base.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_model_base.py index cedbc25ec4df..1ddc071517d6 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_model_base.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_model_base.py @@ -5,8 +5,9 @@ # license information. # -------------------------------------------------------------------------- # pylint: disable=protected-access, arguments-differ, signature-differs, broad-except -# pyright: reportGeneralTypeIssues=false +import calendar +import decimal import functools import sys import logging @@ -14,13 +15,16 @@ import re import copy import typing +import enum +import email.utils from datetime import datetime, date, time, timedelta, timezone from json import JSONEncoder +from typing_extensions import Self import isodate from azure.core.exceptions import DeserializationError from azure.core import CaseInsensitiveEnumMeta from azure.core.pipeline import PipelineResponse -from azure.core.serialization import NULL as AzureCoreNull +from azure.core.serialization import _Null if sys.version_info >= (3, 9): from collections.abc import MutableMapping @@ -29,25 +33,10 @@ _LOGGER = logging.getLogger(__name__) -__all__ = ["NULL", "AzureJSONEncoder", "Model", "rest_field", "rest_discriminator"] - - -class _Null(object): - """To create a Falsy object""" - - def __bool__(self): - return False - - __nonzero__ = __bool__ # Python2 compatibility - - -NULL = _Null() -""" -A falsy sentinel object which is supposed to be used to specify attributes -with no data. This gets serialized to `null` on the wire. -""" +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") def _timedelta_as_isostr(td: timedelta) -> str: @@ -74,69 +63,53 @@ def _timedelta_as_isostr(td: timedelta) -> str: if days: date_str = "%sD" % days - # Build time - time_str = "T" + if hours or minutes or seconds: + # Build time + time_str = "T" - # Hours - bigger_exists = date_str or hours - if bigger_exists: - time_str += "{:02}H".format(hours) + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) - # Minutes - bigger_exists = bigger_exists or minutes - if bigger_exists: - time_str += "{:02}M".format(minutes) + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) - # Seconds - try: - if seconds.is_integer(): - seconds_string = "{:02}".format(int(seconds)) - else: - # 9 chars long w/ leading 0, 6 digits after decimal - seconds_string = "%09.6f" % seconds - # Remove trailing zeros - seconds_string = seconds_string.rstrip("0") - except AttributeError: # int.is_integer() raises - seconds_string = "{:02}".format(seconds) + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) - time_str += "{}S".format(seconds_string) + time_str += "{}S".format(seconds_string) + else: + time_str = "" return "P" + date_str + time_str -def _datetime_as_isostr(dt: typing.Union[datetime, date, time, timedelta]) -> str: - """Converts a datetime.(datetime|date|time|timedelta) object into an ISO 8601 formatted string +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded - :param timedelta dt: The date object to convert - :rtype: str - :return: ISO8601 version of this datetime - """ - # First try datetime.datetime - if hasattr(dt, "year") and hasattr(dt, "hour"): - dt = typing.cast(datetime, dt) - # astimezone() fails for naive times in Python 2.7, so make make sure dt is aware (tzinfo is set) - if not dt.tzinfo: - iso_formatted = dt.replace(tzinfo=TZ_UTC).isoformat() - else: - iso_formatted = dt.astimezone(TZ_UTC).isoformat() - # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) - return iso_formatted.replace("+00:00", "Z") - # Next try datetime.date or datetime.time - try: - dt = typing.cast(typing.Union[date, time], dt) - return dt.isoformat() - # Last, try datetime.timedelta - except AttributeError: - dt = typing.cast(timedelta, dt) - return _timedelta_as_isostr(dt) - -def _serialize_bytes(o) -> str: - return base64.b64encode(o).decode() - - -def _serialize_datetime(o): +def _serialize_datetime(o, format: typing.Optional[str] = None): if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) if not o.tzinfo: iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() @@ -150,32 +123,37 @@ def _serialize_datetime(o): def _is_readonly(p): try: - return p._readonly # pylint: disable=protected-access + return p._visibility == ["read"] # pylint: disable=protected-access except AttributeError: return False -class AzureJSONEncoder(JSONEncoder): +class SdkJSONEncoder(JSONEncoder): """A JSON encoder that's capable of serializing datetime objects and bytes.""" + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + def default(self, o): # pylint: disable=too-many-return-statements if _is_model(o): - readonly_props = [ - p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p) - ] # pylint: disable=protected-access - return {k: v for k, v in o.items() if k not in readonly_props} - if isinstance(o, (bytes, bytearray)): - return base64.b64encode(o).decode() - if o is AzureCoreNull: - return None + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) try: - return super(AzureJSONEncoder, self).default(o) + return super(SdkJSONEncoder, self).default(o) except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) if isinstance(o, (bytes, bytearray)): - return _serialize_bytes(o) + return _serialize_bytes(o, self.format) try: # First try datetime.datetime - return _serialize_datetime(o) + return _serialize_datetime(o, self.format) except AttributeError: pass # Last, try datetime.timedelta @@ -184,10 +162,14 @@ def default(self, o): # pylint: disable=too-many-return-statements except AttributeError: # This will be raised when it hits value.total_seconds in the method above pass - return super(AzureJSONEncoder, self).default(o) + return super(SdkJSONEncoder, self).default(o) _VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: @@ -223,6 +205,36 @@ def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: return date_obj +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + def _deserialize_date(attr: typing.Union[str, date]) -> date: """Deserialize ISO-8601 formatted string into Date object. :param str attr: response string to be deserialized. @@ -232,7 +244,7 @@ def _deserialize_date(attr: typing.Union[str, date]) -> date: # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. if isinstance(attr, date): return attr - return isodate.parse_date(attr, defaultmonth=None, defaultday=None) + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore def _deserialize_time(attr: typing.Union[str, time]) -> time: @@ -247,33 +259,74 @@ def _deserialize_time(attr: typing.Union[str, time]) -> time: return isodate.parse_time(attr) -def deserialize_bytes(attr): +def _deserialize_bytes(attr): if isinstance(attr, (bytes, bytearray)): return attr return bytes(base64.b64decode(attr)) -def deserialize_duration(attr): +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): if isinstance(attr, timedelta): return attr return isodate.parse_duration(attr) +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + _DESERIALIZE_MAPPING = { datetime: _deserialize_datetime, date: _deserialize_date, time: _deserialize_time, - bytes: deserialize_bytes, - timedelta: deserialize_duration, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, } +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + def _get_model(module_name: str, model_name: str): models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} module_end = module_name.rsplit(".", 1)[0] - module = sys.modules[module_end] - models.update({k: v for k, v in module.__dict__.items() if isinstance(v, type)}) + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) if isinstance(model_name, str): model_name = model_name.split(".")[-1] if model_name not in models: @@ -324,8 +377,12 @@ def get(self, key: str, default: typing.Any = None) -> typing.Any: except KeyError: return default - @typing.overload # type: ignore - def pop(self, key: str) -> typing.Any: # pylint: disable=no-member + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... @typing.overload @@ -346,8 +403,8 @@ def clear(self) -> None: def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: self._data.update(*args, **kwargs) - @typing.overload # type: ignore - def setdefault(self, key: str) -> typing.Any: + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... @typing.overload @@ -374,12 +431,24 @@ def _is_model(obj: typing.Any) -> bool: return getattr(obj, "_is_model", False) -def _serialize(o): +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) if isinstance(o, (bytes, bytearray)): - return _serialize_bytes(o) + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value try: # First try datetime.datetime - return _serialize_datetime(o) + return _serialize_datetime(o, format) except AttributeError: pass # Last, try datetime.timedelta @@ -401,7 +470,13 @@ def _get_rest_field( def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: - return _deserialize(rf._type, value) if (rf and rf._is_model) else _serialize(value) + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) class Model(_MyMutableMapping): @@ -425,13 +500,19 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: if non_attr_kwargs: # actual type errors only throw the first wrong keyword arg they see, so following that. raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") - dict_to_pass.update({self._attr_to_rest_field[k]._rest_name: _serialize(v) for k, v in kwargs.items()}) + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) super().__init__(dict_to_pass) def copy(self) -> "Model": return Model(self.__dict__) - def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> "Model": # pylint: disable=unused-argument + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property @@ -459,31 +540,84 @@ def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member @classmethod - def _get_discriminator(cls) -> typing.Optional[str]: + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: for v in cls.__dict__.values(): - if isinstance(v, _RestField) and v._is_discriminator: # pylint: disable=protected-access + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access return v._rest_name # pylint: disable=protected-access return None @classmethod - def _deserialize(cls, data): + def _deserialize(cls, data, exist_discriminators): if not hasattr(cls, "__mapping__"): # pylint: disable=no-member return cls(data) - discriminator = cls._get_discriminator() - mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pylint: disable=no-member + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member if mapped_cls == cls: return cls(data) - return mapped_cls._deserialize(data) # pylint: disable=protected-access + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v -def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-statements - annotation: typing.Any, module: typing.Optional[str], rf: typing.Optional["_RestField"] = None +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: if not annotation or annotation in [int, float]: return None + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + try: - if module and _is_model(_get_model(module, annotation)): + if module and _is_model(annotation): if rf: rf._is_model = True @@ -492,42 +626,22 @@ def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj return obj return _deserialize(model_deserializer, obj) - return functools.partial(_deserialize_model, _get_model(module, annotation)) + return functools.partial(_deserialize_model, annotation) # pyright: ignore except Exception: pass # is it a literal? try: - if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports - else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - - if annotation.__origin__ == Literal: + if annotation.__origin__ is typing.Literal: # pyright: ignore return None except AttributeError: pass - if getattr(annotation, "__origin__", None) is typing.Union: - - def _deserialize_with_union(union_annotation, obj): - for t in union_annotation.__args__: - try: - return _deserialize(t, obj, module) - except DeserializationError: - pass - raise DeserializationError() - - return functools.partial(_deserialize_with_union, annotation) - # is it optional? try: - # right now, assuming we don't have unions, since we're getting rid of the only - # union we used to have in msrest models, which was union of str and enum - if any(a for a in annotation.__args__ if a == type(None)): - + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore if_obj_deserializer = _get_deserialize_callable_from_annotation( - next(a for a in annotation.__args__ if a != type(None)), module, rf + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore ) def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): @@ -539,45 +653,52 @@ def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Calla except AttributeError: pass - # is it a forward ref / in quotes? - if isinstance(annotation, (str, typing.ForwardRef)): - try: - model_name = annotation.__forward_arg__ # type: ignore - except AttributeError: - model_name = annotation - if module is not None: - annotation = _get_model(module, model_name) + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) try: - if annotation._name == "Dict": - key_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) - value_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[1], module, rf) + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) def _deserialize_dict( - key_deserializer: typing.Optional[typing.Callable], value_deserializer: typing.Optional[typing.Callable], obj: typing.Dict[typing.Any, typing.Any], ): if obj is None: return obj - return { - _deserialize(key_deserializer, k, module): _deserialize(value_deserializer, v, module) - for k, v in obj.items() - } + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} return functools.partial( _deserialize_dict, - key_deserializer, value_deserializer, ) except (AttributeError, IndexError): pass try: - if annotation._name in ["List", "Set", "Tuple", "Sequence"]: - if len(annotation.__args__) > 1: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore def _deserialize_multiple_sequence( - entry_deserializers: typing.List[typing.Optional[typing.Callable]], obj + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, ): if obj is None: return obj @@ -587,10 +708,13 @@ def _deserialize_multiple_sequence( ) entry_deserializers = [ - _get_deserialize_callable_from_annotation(dt, module, rf) for dt in annotation.__args__ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore ] return functools.partial(_deserialize_multiple_sequence, entry_deserializers) - deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) def _deserialize_sequence( deserializer: typing.Optional[typing.Callable], @@ -605,26 +729,29 @@ def _deserialize_sequence( pass def _deserialize_default( - annotation, - deserializer_from_mapping, + deserializer, obj, ): if obj is None: return obj try: - return _deserialize_with_callable(annotation, obj) + return _deserialize_with_callable(deserializer, obj) except Exception: pass - return _deserialize_with_callable(deserializer_from_mapping, obj) + return obj - return functools.partial(_deserialize_default, annotation, _DESERIALIZE_MAPPING.get(annotation)) + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) def _deserialize_with_callable( - deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], value: typing.Any + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, ): try: - if value is None: + if value is None or isinstance(value, _Null): return None if deserializer is None: return value @@ -635,16 +762,25 @@ def _deserialize_with_callable( # for unknown value, return raw value return value if isinstance(deserializer, type) and issubclass(deserializer, Model): - return deserializer._deserialize(value) # type: ignore + return deserializer._deserialize(value, []) return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) except Exception as e: raise DeserializationError() from e -def _deserialize(deserializer: typing.Any, value: typing.Any, module: typing.Optional[str] = None) -> typing.Any: +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: if isinstance(value, PipelineResponse): value = value.http_response.json() - deserializer = _get_deserialize_callable_from_annotation(deserializer, module) + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) return _deserialize_with_callable(deserializer, value) @@ -653,18 +789,26 @@ def __init__( self, *, name: typing.Optional[str] = None, - type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin is_discriminator: bool = False, - readonly: bool = False, + visibility: typing.Optional[typing.List[str]] = None, default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, ): self._type = type self._rest_name_input = name self._module: typing.Optional[str] = None self._is_discriminator = is_discriminator - self._readonly = readonly + self._visibility = visibility self._is_model = False self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] @property def _rest_name(self) -> str: @@ -672,13 +816,15 @@ def _rest_name(self) -> str: raise ValueError("Rest name was never set") return self._rest_name_input - def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin # by this point, type and rest_name will have a value bc we default # them in __new__ of the Model class item = obj.get(self._rest_name) if item is None: return item - return _deserialize(self._type, _serialize(item)) + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) def __set__(self, obj: Model, value) -> None: if value is None: @@ -688,9 +834,12 @@ def __set__(self, obj: Model, value) -> None: except KeyError: pass return - if self._is_model and not _is_model(value): - obj.__setitem__(self._rest_name, _deserialize(self._type, value)) - obj.__setitem__(self._rest_name, _serialize(value)) + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) def _get_deserialize_callable_from_annotation( self, annotation: typing.Any @@ -701,14 +850,25 @@ def _get_deserialize_callable_from_annotation( def rest_field( *, name: typing.Optional[str] = None, - type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin - readonly: bool = False, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, ) -> typing.Any: - return _RestField(name=name, type=type, readonly=readonly, default=default) + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + ) def rest_discriminator( - *, name: typing.Optional[str] = None, type: typing.Optional[typing.Callable] = None # pylint: disable=redefined-builtin + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin ) -> typing.Any: return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_operations/_operations.py index c9a1afa2a190..4c1b30cbb86b 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_operations/_operations.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_operations/_operations.py @@ -1,4 +1,4 @@ -# pylint: disable=too-many-lines +# pylint: disable=too-many-lines,too-many-statements # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -7,9 +7,11 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- import datetime +from io import IOBase import json import sys from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload +import uuid from azure.core.exceptions import ( ClientAuthenticationError, @@ -20,15 +22,14 @@ map_error, ) from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import HttpResponse from azure.core.polling import LROPoller, NoPolling, PollingMethod from azure.core.polling.base_polling import LROBasePolling -from azure.core.rest import HttpRequest +from azure.core.rest import HttpRequest, HttpResponse from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict from .. import models as _models -from .._model_base import AzureJSONEncoder, _deserialize +from .._model_base import SdkJSONEncoder, _deserialize from .._serialization import Serializer from .._vendor import ClinicalMatchingClientMixinABC @@ -36,10 +37,6 @@ from collections.abc import MutableMapping else: from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] @@ -48,35 +45,26 @@ _SERIALIZER.client_side_validation = False -def build_clinical_matching_match_trials_request( # pylint: disable=name-too-long - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any -) -> HttpRequest: +def build_clinical_matching_match_trials_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: Literal["2023-03-01-preview"] = kwargs.pop( - "api_version", _params.pop("api-version", "2023-03-01-preview") - ) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL - _url = "/trialmatcher/jobs" + _url = "/trial-matcher/jobs" # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers - if repeatability_request_id is not None: - _headers["Repeatability-Request-ID"] = _SERIALIZER.header( - "repeatability_request_id", repeatability_request_id, "str" - ) - if repeatability_first_sent is not None: - _headers["Repeatability-First-Sent"] = _SERIALIZER.header( - "repeatability_first_sent", repeatability_first_sent, "iso-8601" + if "Repeatability-Request-ID" not in _headers: + _headers["Repeatability-Request-ID"] = str(uuid.uuid4()) + if "Repeatability-First-Sent" not in _headers: + _headers["Repeatability-First-Sent"] = _SERIALIZER.serialize_data( + datetime.datetime.now(datetime.timezone.utc), "rfc-1123" ) _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") if content_type is not None: @@ -86,14 +74,7 @@ def build_clinical_matching_match_trials_request( # pylint: disable=name-too-lo class ClinicalMatchingClientOperationsMixin(ClinicalMatchingClientMixinABC): - def _match_trials_initial( - self, - body: Union[_models.TrialMatcherData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> Optional[_models.TrialMatcherResult]: + def _match_trials_initial(self, body: Union[_models.TrialMatcherData, JSON, IO[bytes]], **kwargs: Any) -> JSON: error_map = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, @@ -106,18 +87,16 @@ def _match_trials_initial( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[Optional[_models.TrialMatcherResult]] = kwargs.pop("cls", None) + cls: ClsType[JSON] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None - if isinstance(body, (IO, bytes)): + if isinstance(body, (IOBase, bytes)): _content = body else: - _content = json.dumps(body, cls=AzureJSONEncoder) # type: ignore + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_clinical_matching_match_trials_request( - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, + _request = build_clinical_matching_match_trials_request( content_type=content_type, api_version=self._config.api_version, content=_content, @@ -127,218 +106,12895 @@ def _match_trials_initial( path_format_arguments = { "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [200, 202]: + if response.status_code not in [202]: + if _stream: + response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) - deserialized = None response_headers = {} - if response.status_code == 200: - deserialized = _deserialize(_models.TrialMatcherResult, response.json()) + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) - if response.status_code == 202: - response_headers["Operation-Location"] = self._deserialize( - "str", response.headers.get("Operation-Location") - ) - response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) - response_headers["Repeatability-Result"] = self._deserialize( - "str", response.headers.get("Repeatability-Result") - ) + deserialized = _deserialize(JSON, response.json()) if cls: - return cls(pipeline_response, deserialized, response_headers) + return cls(pipeline_response, deserialized, response_headers) # type: ignore - return deserialized + return deserialized # type: ignore @overload def begin_match_trials( - self, - body: _models.TrialMatcherData, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> LROPoller[_models.TrialMatcherResult]: + self, body: _models.TrialMatcherData, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. :param body: Required. :type body: ~azure.healthinsights.clinicalmatching.models.TrialMatcherData - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns TrialMatcherResult. The TrialMatcherResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", # Default + value is "ResearchStudy". resourceType. Required. + "status": "str", # active | + administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | + in-review | temporarily-closed-to-accrual | + temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", + "administratively-completed", "approved", "closed-to-accrual", + "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", + "temporarily-closed-to-accrual-and-intervention", and + "withdrawn". + "arm": [ + { + "name": "str", # Label for + study arm. Required. + "description": "str", # + Optional. Short explanation of study path. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "category": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "condition": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "contact": [ + { + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "name": "str", # Optional. + Name of an individual to contact. + "telecom": [ + { + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "rank": 0, # + Optional. Specify preferred order of use (1 = + highest). + "system": + "str", # Optional. phone | fax | email | pager | + url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and + "other". + "use": "str", + # Optional. home | work | temp | old | mobile - + purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + "value": + "str" # Optional. The actual contact point + details. + } + ] + } + ], + "contained": [ + { + "resourceType": "str", # The + type of resource. Required. + "id": "str", # Optional. + Resource Id. + "implicitRules": "str", # + Optional. A set of rules under which this content was + created. + "language": "str", # + Optional. Language of the resource content. + "meta": { + "lastUpdated": "str", + # Optional. When the resource last changed - e.g. + when the version changed. + "profile": [ + "str" # + Optional. A list of profiles (references to + `StructureDefinition + `_ + resources) that this resource claims to conform + to. The URL is a reference to + `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "source": "str", # + Optional. A uri that identifies the source system of + the resource. This provides a minimal amount of + Provenance information that can be used to track or + differentiate the source of information in the + resource. The source may identify another FHIR + server, document, message, database, etc. + "tag": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it + appears in the version portion of the URL. This value + changes when the resource is created, updated, or + deleted. + } + } + ], + "description": "str", # Optional. What this + is study doing. + "enrollment": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "focus": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "id": "str", # Optional. Resource Id. + "identifier": [ + { + "assigner": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": ..., + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": ..., + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + } + ], + "implicitRules": "str", # Optional. A set of + rules under which this content was created. + "keyword": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "language": "str", # Optional. Language of + the resource content. + "location": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "meta": { + "lastUpdated": "str", # Optional. + When the resource last changed - e.g. when the version + changed. + "profile": [ + "str" # Optional. A list of + profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. The + URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "source": "str", # Optional. A uri + that identifies the source system of the resource. This + provides a minimal amount of Provenance information that can + be used to track or differentiate the source of information + in the resource. The source may identify another FHIR server, + document, message, database, etc. + "tag": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "versionId": "str" # Optional. The + version specific identifier, as it appears in the version + portion of the URL. This value changes when the resource is + created, updated, or deleted. + }, + "modifierExtension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "note": [ + { + "text": "str", # The + annotation - text content (as markdown). Required. + "authorString": "str", # + Optional. Individual responsible for the annotation. + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "time": "str" # Optional. + When the annotation was made. + } + ], + "objective": [ + { + "name": "str", # Label for + the objective. Required. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "partOf": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "phase": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "primaryPurposeType": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "principalInvestigator": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "protocol": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "reasonStopped": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "site": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "sponsor": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "text": { + "div": "str", # xhtml. Required. + "status": "str", # generated, + extensions, additional, empty. Required. + "extension": [ + { + "url": "str", # + Source of the definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, + # Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "valueDateTime": + "str", # Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": + { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": + "str", # Optional. Text alternative for the + resource. + "identifier": + { + "assigner": ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. The namespace + for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | official | + temp | secondary | old (If known). + "value": "str" # Optional. The value that is + unique. + }, + "reference": + "str", # Optional. Literal reference, Relative, + internal or absolute URL. + "type": "str" + # Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": + 0, # Number of sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": + 0.0, # Number of milliseconds between samples. + Required. + "data": + "str", # Optional. Decimal values with spaces, + or "E" | "U" | "L". + "factor": + 0.0, # Optional. Multiply data by this before + adding to origin. + "lowerLimit": + 0.0, # Optional. Lower limit of detection. + "upperLimit": + 0.0 # Optional. Upper limit of detection. + }, + "valueString": "str", + # Optional. Value as string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str" # Optional. Unique id + for inter-element referencing. + }, + "title": "str" # Optional. Name for this + study. + } + ], + "registryFilters": [ + { + "conditions": [ + "str" # Optional. Trials with any of + the given medical conditions will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the medical + conditions. + ], + "facilityAreas": [ + { + "geometry": { + "coordinates": [ + 0.0 # + Coordinates of the area circle's center, + represented according to the ``GeoJSON`` + standard. This is an array of 2 decimal numbers, + longitude and latitude (precisely in this order). + Required. + ], + "type": "str" # + ``GeoJSON`` geometry type. Required. "Point" + }, + "properties": { + "radius": 0.0, # The + radius of the area's circle, in meters. Required. + "subType": "str" # + ``GeoJSON`` object sub-type. Required. "Circle" + }, + "type": "str" # ``GeoJSON`` + type. Required. "Feature" + } + ], + "facilityLocations": [ + { + "countryOrRegion": "str", # + Country/region name. Required. + "city": "str", # Optional. + City name. + "state": "str" # Optional. + State name. + } + ], + "facilityNames": [ + "str" # Optional. Trials with any of + the given facility names will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial facility names. + ], + "ids": [ + "str" # Optional. Trials with any of + the given identifiers will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial identifiers. + ], + "phases": [ + "str" # Optional. Trials with any of + the given phases will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the phases. + ], + "purposes": [ + "str" # Optional. Trials with any of + the given purposes will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the purposes. + ], + "recruitmentStatuses": [ + "str" # Optional. Trials with any of + the given recruitment statuses will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the recruitment + statuses. + ], + "sources": [ + "str" # Optional. Trials with any of + the given sources will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the sources. + ], + "sponsors": [ + "str" # Optional. Trials with any of + the given sponsors will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the sponsors. + ], + "studyTypes": [ + "str" # Optional. Trials with any of + the given study types will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the study types. + ] + } + ] + }, + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ @overload def begin_match_trials( - self, - body: JSON, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> LROPoller[_models.TrialMatcherResult]: + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. :param body: Required. :type body: JSON - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns TrialMatcherResult. The TrialMatcherResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ @overload def begin_match_trials( - self, - body: IO, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> LROPoller[_models.TrialMatcherResult]: + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. :param body: Required. - :type body: IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime + :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns TrialMatcherResult. The TrialMatcherResult is - compatible with MutableMapping + :return: An instance of LROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ @distributed_trace def begin_match_trials( - self, - body: Union[_models.TrialMatcherData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> LROPoller[_models.TrialMatcherResult]: + self, body: Union[_models.TrialMatcherData, JSON, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. - :param body: Is one of the following types: TrialMatcherData, JSON, IO Required. - :type body: ~azure.healthinsights.clinicalmatching.models.TrialMatcherData or JSON or IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for - this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.PollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of LROPoller that returns TrialMatcherResult. The TrialMatcherResult is - compatible with MutableMapping + :param body: Is one of the following types: TrialMatcherData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.clinicalmatching.models.TrialMatcherData or JSON or IO[bytes] + :return: An instance of LROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.LROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", # Default + value is "ResearchStudy". resourceType. Required. + "status": "str", # active | + administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | + in-review | temporarily-closed-to-accrual | + temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", + "administratively-completed", "approved", "closed-to-accrual", + "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", + "temporarily-closed-to-accrual-and-intervention", and + "withdrawn". + "arm": [ + { + "name": "str", # Label for + study arm. Required. + "description": "str", # + Optional. Short explanation of study path. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "category": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "condition": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "contact": [ + { + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "name": "str", # Optional. + Name of an individual to contact. + "telecom": [ + { + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "rank": 0, # + Optional. Specify preferred order of use (1 = + highest). + "system": + "str", # Optional. phone | fax | email | pager | + url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and + "other". + "use": "str", + # Optional. home | work | temp | old | mobile - + purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + "value": + "str" # Optional. The actual contact point + details. + } + ] + } + ], + "contained": [ + { + "resourceType": "str", # The + type of resource. Required. + "id": "str", # Optional. + Resource Id. + "implicitRules": "str", # + Optional. A set of rules under which this content was + created. + "language": "str", # + Optional. Language of the resource content. + "meta": { + "lastUpdated": "str", + # Optional. When the resource last changed - e.g. + when the version changed. + "profile": [ + "str" # + Optional. A list of profiles (references to + `StructureDefinition + `_ + resources) that this resource claims to conform + to. The URL is a reference to + `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "source": "str", # + Optional. A uri that identifies the source system of + the resource. This provides a minimal amount of + Provenance information that can be used to track or + differentiate the source of information in the + resource. The source may identify another FHIR + server, document, message, database, etc. + "tag": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it + appears in the version portion of the URL. This value + changes when the resource is created, updated, or + deleted. + } + } + ], + "description": "str", # Optional. What this + is study doing. + "enrollment": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "focus": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "id": "str", # Optional. Resource Id. + "identifier": [ + { + "assigner": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": ..., + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": ..., + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + } + ], + "implicitRules": "str", # Optional. A set of + rules under which this content was created. + "keyword": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "language": "str", # Optional. Language of + the resource content. + "location": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "meta": { + "lastUpdated": "str", # Optional. + When the resource last changed - e.g. when the version + changed. + "profile": [ + "str" # Optional. A list of + profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. The + URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "source": "str", # Optional. A uri + that identifies the source system of the resource. This + provides a minimal amount of Provenance information that can + be used to track or differentiate the source of information + in the resource. The source may identify another FHIR server, + document, message, database, etc. + "tag": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "versionId": "str" # Optional. The + version specific identifier, as it appears in the version + portion of the URL. This value changes when the resource is + created, updated, or deleted. + }, + "modifierExtension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "note": [ + { + "text": "str", # The + annotation - text content (as markdown). Required. + "authorString": "str", # + Optional. Individual responsible for the annotation. + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "time": "str" # Optional. + When the annotation was made. + } + ], + "objective": [ + { + "name": "str", # Label for + the objective. Required. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "partOf": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "phase": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "primaryPurposeType": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "principalInvestigator": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "protocol": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "reasonStopped": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "site": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "sponsor": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "text": { + "div": "str", # xhtml. Required. + "status": "str", # generated, + extensions, additional, empty. Required. + "extension": [ + { + "url": "str", # + Source of the definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, + # Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "valueDateTime": + "str", # Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": + { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": + "str", # Optional. Text alternative for the + resource. + "identifier": + { + "assigner": ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. The namespace + for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | official | + temp | secondary | old (If known). + "value": "str" # Optional. The value that is + unique. + }, + "reference": + "str", # Optional. Literal reference, Relative, + internal or absolute URL. + "type": "str" + # Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": + 0, # Number of sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": + 0.0, # Number of milliseconds between samples. + Required. + "data": + "str", # Optional. Decimal values with spaces, + or "E" | "U" | "L". + "factor": + 0.0, # Optional. Multiply data by this before + adding to origin. + "lowerLimit": + 0.0, # Optional. Lower limit of detection. + "upperLimit": + 0.0 # Optional. Upper limit of detection. + }, + "valueString": "str", + # Optional. Value as string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str" # Optional. Unique id + for inter-element referencing. + }, + "title": "str" # Optional. Name for this + study. + } + ], + "registryFilters": [ + { + "conditions": [ + "str" # Optional. Trials with any of + the given medical conditions will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the medical + conditions. + ], + "facilityAreas": [ + { + "geometry": { + "coordinates": [ + 0.0 # + Coordinates of the area circle's center, + represented according to the ``GeoJSON`` + standard. This is an array of 2 decimal numbers, + longitude and latitude (precisely in this order). + Required. + ], + "type": "str" # + ``GeoJSON`` geometry type. Required. "Point" + }, + "properties": { + "radius": 0.0, # The + radius of the area's circle, in meters. Required. + "subType": "str" # + ``GeoJSON`` object sub-type. Required. "Circle" + }, + "type": "str" # ``GeoJSON`` + type. Required. "Feature" + } + ], + "facilityLocations": [ + { + "countryOrRegion": "str", # + Country/region name. Required. + "city": "str", # Optional. + City name. + "state": "str" # Optional. + State name. + } + ], + "facilityNames": [ + "str" # Optional. Trials with any of + the given facility names will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial facility names. + ], + "ids": [ + "str" # Optional. Trials with any of + the given identifiers will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial identifiers. + ], + "phases": [ + "str" # Optional. Trials with any of + the given phases will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the phases. + ], + "purposes": [ + "str" # Optional. Trials with any of + the given purposes will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the purposes. + ], + "recruitmentStatuses": [ + "str" # Optional. Trials with any of + the given recruitment statuses will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the recruitment + statuses. + ], + "sources": [ + "str" # Optional. Trials with any of + the given sources will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the sources. + ], + "sponsors": [ + "str" # Optional. Trials with any of + the given sponsors will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the sponsors. + ], + "studyTypes": [ + "str" # Optional. Trials with any of + the given study types will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the study types. + ] + } + ] + }, + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.TrialMatcherResult] = kwargs.pop("cls", None) + cls: ClsType[_models.TrialMatcherInferenceResult] = kwargs.pop("cls", None) polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token: Optional[str] = kwargs.pop("continuation_token", None) if cont_token is None: raw_result = self._match_trials_initial( - body=body, - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, - content_type=content_type, - cls=lambda x, y, z: x, - headers=_headers, - params=_params, - **kwargs + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs ) kwargs.pop("error_map", None) def get_long_running_output(pipeline_response): + response_headers = {} response = pipeline_response.http_response - deserialized = _deserialize(_models.TrialMatcherResult, response.json()) + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.TrialMatcherInferenceResult, response.json().get("result")) if cls: - return cls(pipeline_response, deserialized, {}) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized path_format_arguments = { @@ -354,10 +13010,12 @@ def get_long_running_output(pipeline_response): else: polling_method = polling if cont_token: - return LROPoller.from_continuation_token( + return LROPoller[_models.TrialMatcherInferenceResult].from_continuation_token( polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output, ) - return LROPoller(self._client, raw_result, get_long_running_output, polling_method) # type: ignore + return LROPoller[_models.TrialMatcherInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_serialization.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_serialization.py index f17c068e833e..2f781d740827 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_serialization.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/_serialization.py @@ -63,8 +63,8 @@ import isodate # type: ignore -from azure.core.exceptions import DeserializationError, SerializationError, raise_with_traceback -from azure.core.serialization import NULL as AzureCoreNull +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull _BOM = codecs.BOM_UTF8.decode(encoding="utf-8") @@ -124,7 +124,7 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: pass return ET.fromstring(data_as_str) # nosec - except ET.ParseError: + except ET.ParseError as err: # It might be because the server has an issue, and returned JSON with # content-type XML.... # So let's try a JSON load, and if it's still broken @@ -143,7 +143,7 @@ def _json_attemp(data): # The function hack is because Py2.7 messes up with exception # context otherwise. _LOGGER.critical("Wasn't XML not JSON, failing") - raise_with_traceback(DeserializationError, "XML is invalid") + raise DeserializationError("XML is invalid") from err raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) @classmethod @@ -170,13 +170,6 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], return None -try: - basestring # type: ignore - unicode_str = unicode # type: ignore -except NameError: - basestring = str - unicode_str = str - _LOGGER = logging.getLogger(__name__) try: @@ -295,7 +288,7 @@ class Model(object): _validation: Dict[str, Dict[str, Any]] = {} def __init__(self, **kwargs: Any) -> None: - self.additional_properties: Dict[str, Any] = {} + self.additional_properties: Optional[Dict[str, Any]] = {} for k in kwargs: if k not in self._attribute_map: _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) @@ -340,7 +333,7 @@ def _create_xml_node(cls): return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: - """Return the JSON that would be sent to azure from this model. + """Return the JSON that would be sent to server from this model. This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. @@ -351,7 +344,7 @@ def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore def as_dict( self, @@ -390,7 +383,7 @@ def my_key_transformer(key, attr_desc, value): :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore @classmethod def _infer_class_models(cls): @@ -415,7 +408,7 @@ def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = N :raises: DeserializationError if something went wrong """ deserializer = Deserializer(cls._infer_class_models()) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def from_dict( @@ -445,7 +438,7 @@ def from_dict( if key_extractors is None else key_extractors ) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def _flatten_subtype(cls, key, objects): @@ -545,7 +538,7 @@ class Serializer(object): "multiple": lambda x, y: x % y != 0, } - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.serialize_type = { "iso-8601": Serializer.serialize_iso, "rfc-1123": Serializer.serialize_rfc, @@ -561,7 +554,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "[]": self.serialize_iter, "{}": self.serialize_dict, } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: Dict[str, type] = dict(classes) if classes else {} self.key_transformer = full_restapi_key_transformer self.client_side_validation = True @@ -629,7 +622,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): if xml_desc.get("attr", False): if xml_ns: ET.register_namespace(xml_prefix, xml_ns) - xml_name = "{}{}".format(xml_ns, xml_name) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) serialized.set(xml_name, new_attr) # type: ignore continue if xml_desc.get("text", False): @@ -649,7 +642,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): else: # That's a basic type # Integrate namespace if necessary local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) - local_node.text = unicode_str(new_attr) + local_node.text = str(new_attr) serialized.append(local_node) # type: ignore else: # JSON for k in reversed(keys): # type: ignore @@ -662,12 +655,13 @@ def _serialize(self, target_obj, data_type=None, **kwargs): _serialized.update(_new_attr) # type: ignore _new_attr = _new_attr[k] # type: ignore _serialized = _serialized[k] - except ValueError: - continue + except ValueError as err: + if isinstance(err, SerializationError): + raise except (AttributeError, KeyError, TypeError) as err: msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) - raise_with_traceback(SerializationError, msg, err) + raise SerializationError(msg) from err else: return serialized @@ -709,7 +703,7 @@ def body(self, data, data_type, **kwargs): ] data = deserializer._deserialize(data_type, data) except DeserializationError as err: - raise_with_traceback(SerializationError, "Unable to build a model: " + str(err), err) + raise SerializationError("Unable to build a model: " + str(err)) from err return self._serialize(data, data_type, **kwargs) @@ -729,6 +723,7 @@ def url(self, name, data, data_type, **kwargs): if kwargs.get("skip_quote") is True: output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) else: output = quote(str(output), safe="") except SerializationError: @@ -741,7 +736,9 @@ def query(self, name, data, data_type, **kwargs): :param data: The data to be serialized. :param str data_type: The type to be serialized from. - :rtype: str + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list :raises: TypeError if serialization fails. :raises: ValueError if data is None """ @@ -749,10 +746,8 @@ def query(self, name, data, data_type, **kwargs): # Treat the list aside, since we don't want to encode the div separator if data_type.startswith("["): internal_data_type = data_type[1:-1] - data = [self.serialize_data(d, internal_data_type, **kwargs) if d is not None else "" for d in data] - if not kwargs.get("skip_quote", False): - data = [quote(str(d), safe="") for d in data] - return str(self.serialize_iter(data, internal_data_type, **kwargs)) + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) # Not a list, regular serialization output = self.serialize_data(data, data_type, **kwargs) @@ -803,7 +798,7 @@ def serialize_data(self, data, data_type, **kwargs): raise ValueError("No value for given attribute") try: - if data is AzureCoreNull: + if data is CoreNull: return None if data_type in self.basic_types.values(): return self.serialize_basic(data, data_type, **kwargs) @@ -823,7 +818,7 @@ def serialize_data(self, data, data_type, **kwargs): except (ValueError, TypeError) as err: msg = "Unable to serialize value: {!r} as type: {!r}." - raise_with_traceback(SerializationError, msg.format(data, data_type), err) + raise SerializationError(msg.format(data, data_type)) from err else: return self._serialize(data, **kwargs) @@ -891,6 +886,8 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): not be None or empty. :param str div: If set, this str will be used to combine the elements in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. :rtype: list, str """ if isinstance(data, str): @@ -903,9 +900,14 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): for d in data: try: serialized.append(self.serialize_data(d, iter_type, **kwargs)) - except ValueError: + except ValueError as err: + if isinstance(err, SerializationError): + raise serialized.append(None) + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + if div: serialized = ["" if s is None else str(s) for s in serialized] serialized = div.join(serialized) @@ -950,7 +952,9 @@ def serialize_dict(self, attr, dict_type, **kwargs): for key, value in attr.items(): try: serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) - except ValueError: + except ValueError as err: + if isinstance(err, SerializationError): + raise serialized[self.serialize_unicode(key)] = None if "xml" in serialization_ctxt: @@ -983,7 +987,7 @@ def serialize_object(self, attr, **kwargs): return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) if obj_type is _long_type: return self.serialize_long(attr) - if obj_type is unicode_str: + if obj_type is str: return self.serialize_unicode(attr) if obj_type is datetime.datetime: return self.serialize_iso(attr) @@ -1160,10 +1164,10 @@ def serialize_iso(attr, **kwargs): return date + microseconds + "Z" except (ValueError, OverflowError) as err: msg = "Unable to serialize datetime object." - raise_with_traceback(SerializationError, msg, err) + raise SerializationError(msg) from err except AttributeError as err: msg = "ISO-8601 object must be valid Datetime object." - raise_with_traceback(TypeError, msg, err) + raise TypeError(msg) from err @staticmethod def serialize_unix(attr, **kwargs): @@ -1199,7 +1203,6 @@ def rest_key_extractor(attr, attr_desc, data): if working_data is None: # If at any point while following flatten JSON path see None, it means # that all properties under are None as well - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) @@ -1220,7 +1223,6 @@ def rest_key_case_insensitive_extractor(attr, attr_desc, data): if working_data is None: # If at any point while following flatten JSON path see None, it means # that all properties under are None as well - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) @@ -1271,7 +1273,7 @@ def _extract_name_from_internal_type(internal_type): xml_name = internal_type_xml_map.get("name", internal_type.__name__) xml_ns = internal_type_xml_map.get("ns", None) if xml_ns: - xml_name = "{}{}".format(xml_ns, xml_name) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) return xml_name @@ -1295,7 +1297,7 @@ def xml_key_extractor(attr, attr_desc, data): # Integrate namespace if necessary xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) if xml_ns: - xml_name = "{}{}".format(xml_ns, xml_name) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) # If it's an attribute, that's simple if xml_desc.get("attr", False): @@ -1361,7 +1363,7 @@ class Deserializer(object): valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.deserialize_type = { "iso-8601": Deserializer.deserialize_iso, "rfc-1123": Deserializer.deserialize_rfc, @@ -1381,7 +1383,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "duration": (isodate.Duration, datetime.timedelta), "iso-8601": (datetime.datetime), } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: Dict[str, type] = dict(classes) if classes else {} self.key_extractors = [rest_key_extractor, xml_key_extractor] # Additional properties only works if the "rest_key_extractor" is used to # extract the keys. Making it to work whatever the key extractor is too much @@ -1434,7 +1436,7 @@ def _deserialize(self, target_obj, data): response, class_name = self._classify_target(target_obj, data) - if isinstance(response, basestring): + if isinstance(response, str): return self.deserialize_data(data, response) elif isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) @@ -1471,7 +1473,7 @@ def _deserialize(self, target_obj, data): d_attrs[attr] = value except (AttributeError, TypeError, KeyError) as err: msg = "Unable to deserialize to object: " + class_name # type: ignore - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: additional_properties = self._build_additional_properties(attributes, data) return self._instantiate_model(response, d_attrs, additional_properties) @@ -1505,14 +1507,14 @@ def _classify_target(self, target, data): if target is None: return None, None - if isinstance(target, basestring): + if isinstance(target, str): try: target = self.dependencies[target] except KeyError: return target, target try: - target = target._classify(data, self.dependencies) + target = target._classify(data, self.dependencies) # type: ignore except AttributeError: pass # Target is not a Model, no classify return target, target.__class__.__name__ # type: ignore @@ -1568,7 +1570,7 @@ def _unpack_content(raw_data, content_type=None): if hasattr(raw_data, "_content_consumed"): return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) - if isinstance(raw_data, (basestring, bytes)) or hasattr(raw_data, "read"): + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore return raw_data @@ -1642,7 +1644,7 @@ def deserialize_data(self, data, data_type): except (ValueError, TypeError, AttributeError) as err: msg = "Unable to deserialize response data." msg += " Data: {}, {}".format(data, data_type) - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return self._deserialize(obj_type, data) @@ -1690,7 +1692,7 @@ def deserialize_object(self, attr, **kwargs): if isinstance(attr, ET.Element): # Do no recurse on XML, just return the tree as-is return attr - if isinstance(attr, basestring): + if isinstance(attr, str): return self.deserialize_basic(attr, "str") obj_type = type(attr) if obj_type in self.basic_types: @@ -1747,7 +1749,7 @@ def deserialize_basic(self, attr, data_type): if data_type == "bool": if attr in [True, False, 1, 0]: return bool(attr) - elif isinstance(attr, basestring): + elif isinstance(attr, str): if attr.lower() in ["true", "1"]: return True elif attr.lower() in ["false", "0"]: @@ -1798,7 +1800,6 @@ def deserialize_enum(data, enum_obj): data = data.value if isinstance(data, int): # Workaround. We might consider remove it in the future. - # https://github.com/Azure/azure-rest-api-specs/issues/141 try: return list(enum_obj.__members__.values())[data] except IndexError: @@ -1852,10 +1853,10 @@ def deserialize_decimal(attr): if isinstance(attr, ET.Element): attr = attr.text try: - return decimal.Decimal(attr) # type: ignore + return decimal.Decimal(str(attr)) # type: ignore except decimal.DecimalException as err: msg = "Invalid decimal {}".format(attr) - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err @staticmethod def deserialize_long(attr): @@ -1883,7 +1884,7 @@ def deserialize_duration(attr): duration = isodate.parse_duration(attr) except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize duration object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return duration @@ -1900,7 +1901,7 @@ def deserialize_date(attr): if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore raise DeserializationError("Date must have only digits and -. Received: %s" % attr) # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. - return isodate.parse_date(attr, defaultmonth=None, defaultday=None) + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) @staticmethod def deserialize_time(attr): @@ -1935,7 +1936,7 @@ def deserialize_rfc(attr): date_obj = date_obj.astimezone(tz=TZ_UTC) except ValueError as err: msg = "Cannot deserialize to rfc datetime object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return date_obj @@ -1972,7 +1973,7 @@ def deserialize_iso(attr): raise OverflowError("Hit max or min date") except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize datetime object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return date_obj @@ -1988,9 +1989,10 @@ def deserialize_unix(attr): if isinstance(attr, ET.Element): attr = int(attr.text) # type: ignore try: + attr = int(attr) date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) except ValueError as err: msg = "Cannot deserialize to unix datetime object." - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err else: return date_obj diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_client.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_client.py index dfebacf83a9e..2f4c04c7429f 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_client.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_client.py @@ -11,6 +11,7 @@ from azure.core import AsyncPipelineClient from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies from azure.core.rest import AsyncHttpResponse, HttpRequest from .._serialization import Deserializer, Serializer @@ -29,7 +30,7 @@ class ClinicalMatchingClient( :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str :keyword int polling_interval: Default waiting time between two polls for LRO operations if no @@ -37,15 +38,34 @@ class ClinicalMatchingClient( """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - _endpoint = "{endpoint}/healthinsights" + _endpoint = "{endpoint}/health-insights" self._config = ClinicalMatchingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, config=self._config, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) self._serialize = Serializer() self._deserialize = Deserializer() self._serialize.client_side_validation = False - def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]: + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -69,7 +89,7 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHt } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore async def close(self) -> None: await self._client.close() diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_configuration.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_configuration.py index 314f7a586354..c596242ae3b1 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_configuration.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_configuration.py @@ -6,22 +6,15 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import sys from typing import Any -from azure.core.configuration import Configuration from azure.core.credentials import AzureKeyCredential from azure.core.pipeline import policies from .._version import VERSION -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - -class ClinicalMatchingClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes +class ClinicalMatchingClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long """Configuration for ClinicalMatchingClient. Note that all parameters used to create this instance are saved as instance @@ -33,14 +26,13 @@ class ClinicalMatchingClientConfiguration(Configuration): # pylint: disable=too :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.AzureKeyCredential :keyword api_version: The API version to use for this operation. Default value is - "2023-03-01-preview". Note that overriding this default value may result in unsupported + "2023-09-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: - super(ClinicalMatchingClientConfiguration, self).__init__(**kwargs) - api_version: Literal["2023-03-01-preview"] = kwargs.pop("api_version", "2023-03-01-preview") + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -51,6 +43,7 @@ def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) self.credential = credential self.api_version = api_version kwargs.setdefault("sdk_moniker", "healthinsights-clinicalmatching/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -59,9 +52,9 @@ def _configure(self, **kwargs: Any) -> None: self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) - self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) self.authentication_policy = kwargs.get("authentication_policy") if self.credential and not self.authentication_policy: self.authentication_policy = policies.AzureKeyCredentialPolicy( diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_operations/_operations.py index 4de54baf9d20..d569c3f9880a 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_operations/_operations.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/aio/_operations/_operations.py @@ -1,4 +1,4 @@ -# pylint: disable=too-many-lines +# pylint: disable=too-many-lines,too-many-statements # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -6,7 +6,7 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import datetime +from io import IOBase import json import sys from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload @@ -20,15 +20,14 @@ map_error, ) from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import AsyncHttpResponse from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod from azure.core.polling.async_base_polling import AsyncLROBasePolling -from azure.core.rest import HttpRequest +from azure.core.rest import AsyncHttpResponse, HttpRequest from azure.core.tracing.decorator_async import distributed_trace_async from azure.core.utils import case_insensitive_dict from ... import models as _models -from ..._model_base import AzureJSONEncoder, _deserialize +from ..._model_base import SdkJSONEncoder, _deserialize from ..._operations._operations import build_clinical_matching_match_trials_request from .._vendor import ClinicalMatchingClientMixinABC @@ -43,13 +42,8 @@ class ClinicalMatchingClientOperationsMixin(ClinicalMatchingClientMixinABC): async def _match_trials_initial( - self, - body: Union[_models.TrialMatcherData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> Optional[_models.TrialMatcherResult]: + self, body: Union[_models.TrialMatcherData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: error_map = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, @@ -62,18 +56,16 @@ async def _match_trials_initial( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[Optional[_models.TrialMatcherResult]] = kwargs.pop("cls", None) + cls: ClsType[JSON] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None - if isinstance(body, (IO, bytes)): + if isinstance(body, (IOBase, bytes)): _content = body else: - _content = json.dumps(body, cls=AzureJSONEncoder) # type: ignore + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_clinical_matching_match_trials_request( - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, + _request = build_clinical_matching_match_trials_request( content_type=content_type, api_version=self._config.api_version, content=_content, @@ -83,218 +75,12895 @@ async def _match_trials_initial( path_format_arguments = { "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [200, 202]: + if response.status_code not in [202]: + if _stream: + await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) - deserialized = None response_headers = {} - if response.status_code == 200: - deserialized = _deserialize(_models.TrialMatcherResult, response.json()) + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) - if response.status_code == 202: - response_headers["Operation-Location"] = self._deserialize( - "str", response.headers.get("Operation-Location") - ) - response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) - response_headers["Repeatability-Result"] = self._deserialize( - "str", response.headers.get("Repeatability-Result") - ) + deserialized = _deserialize(JSON, response.json()) if cls: - return cls(pipeline_response, deserialized, response_headers) + return cls(pipeline_response, deserialized, response_headers) # type: ignore - return deserialized + return deserialized # type: ignore @overload async def begin_match_trials( - self, - body: _models.TrialMatcherData, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> AsyncLROPoller[_models.TrialMatcherResult]: + self, body: _models.TrialMatcherData, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. :param body: Required. :type body: ~azure.healthinsights.clinicalmatching.models.TrialMatcherData - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns TrialMatcherResult. The TrialMatcherResult - is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", # Default + value is "ResearchStudy". resourceType. Required. + "status": "str", # active | + administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | + in-review | temporarily-closed-to-accrual | + temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", + "administratively-completed", "approved", "closed-to-accrual", + "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", + "temporarily-closed-to-accrual-and-intervention", and + "withdrawn". + "arm": [ + { + "name": "str", # Label for + study arm. Required. + "description": "str", # + Optional. Short explanation of study path. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "category": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "condition": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "contact": [ + { + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "name": "str", # Optional. + Name of an individual to contact. + "telecom": [ + { + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "rank": 0, # + Optional. Specify preferred order of use (1 = + highest). + "system": + "str", # Optional. phone | fax | email | pager | + url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and + "other". + "use": "str", + # Optional. home | work | temp | old | mobile - + purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + "value": + "str" # Optional. The actual contact point + details. + } + ] + } + ], + "contained": [ + { + "resourceType": "str", # The + type of resource. Required. + "id": "str", # Optional. + Resource Id. + "implicitRules": "str", # + Optional. A set of rules under which this content was + created. + "language": "str", # + Optional. Language of the resource content. + "meta": { + "lastUpdated": "str", + # Optional. When the resource last changed - e.g. + when the version changed. + "profile": [ + "str" # + Optional. A list of profiles (references to + `StructureDefinition + `_ + resources) that this resource claims to conform + to. The URL is a reference to + `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "source": "str", # + Optional. A uri that identifies the source system of + the resource. This provides a minimal amount of + Provenance information that can be used to track or + differentiate the source of information in the + resource. The source may identify another FHIR + server, document, message, database, etc. + "tag": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it + appears in the version portion of the URL. This value + changes when the resource is created, updated, or + deleted. + } + } + ], + "description": "str", # Optional. What this + is study doing. + "enrollment": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "focus": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "id": "str", # Optional. Resource Id. + "identifier": [ + { + "assigner": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": ..., + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": ..., + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + } + ], + "implicitRules": "str", # Optional. A set of + rules under which this content was created. + "keyword": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "language": "str", # Optional. Language of + the resource content. + "location": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "meta": { + "lastUpdated": "str", # Optional. + When the resource last changed - e.g. when the version + changed. + "profile": [ + "str" # Optional. A list of + profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. The + URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "source": "str", # Optional. A uri + that identifies the source system of the resource. This + provides a minimal amount of Provenance information that can + be used to track or differentiate the source of information + in the resource. The source may identify another FHIR server, + document, message, database, etc. + "tag": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "versionId": "str" # Optional. The + version specific identifier, as it appears in the version + portion of the URL. This value changes when the resource is + created, updated, or deleted. + }, + "modifierExtension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "note": [ + { + "text": "str", # The + annotation - text content (as markdown). Required. + "authorString": "str", # + Optional. Individual responsible for the annotation. + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "time": "str" # Optional. + When the annotation was made. + } + ], + "objective": [ + { + "name": "str", # Label for + the objective. Required. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "partOf": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "phase": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "primaryPurposeType": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "principalInvestigator": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "protocol": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "reasonStopped": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "site": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "sponsor": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "text": { + "div": "str", # xhtml. Required. + "status": "str", # generated, + extensions, additional, empty. Required. + "extension": [ + { + "url": "str", # + Source of the definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, + # Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "valueDateTime": + "str", # Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": + { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": + "str", # Optional. Text alternative for the + resource. + "identifier": + { + "assigner": ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. The namespace + for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | official | + temp | secondary | old (If known). + "value": "str" # Optional. The value that is + unique. + }, + "reference": + "str", # Optional. Literal reference, Relative, + internal or absolute URL. + "type": "str" + # Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": + 0, # Number of sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": + 0.0, # Number of milliseconds between samples. + Required. + "data": + "str", # Optional. Decimal values with spaces, + or "E" | "U" | "L". + "factor": + 0.0, # Optional. Multiply data by this before + adding to origin. + "lowerLimit": + 0.0, # Optional. Lower limit of detection. + "upperLimit": + 0.0 # Optional. Upper limit of detection. + }, + "valueString": "str", + # Optional. Value as string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str" # Optional. Unique id + for inter-element referencing. + }, + "title": "str" # Optional. Name for this + study. + } + ], + "registryFilters": [ + { + "conditions": [ + "str" # Optional. Trials with any of + the given medical conditions will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the medical + conditions. + ], + "facilityAreas": [ + { + "geometry": { + "coordinates": [ + 0.0 # + Coordinates of the area circle's center, + represented according to the ``GeoJSON`` + standard. This is an array of 2 decimal numbers, + longitude and latitude (precisely in this order). + Required. + ], + "type": "str" # + ``GeoJSON`` geometry type. Required. "Point" + }, + "properties": { + "radius": 0.0, # The + radius of the area's circle, in meters. Required. + "subType": "str" # + ``GeoJSON`` object sub-type. Required. "Circle" + }, + "type": "str" # ``GeoJSON`` + type. Required. "Feature" + } + ], + "facilityLocations": [ + { + "countryOrRegion": "str", # + Country/region name. Required. + "city": "str", # Optional. + City name. + "state": "str" # Optional. + State name. + } + ], + "facilityNames": [ + "str" # Optional. Trials with any of + the given facility names will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial facility names. + ], + "ids": [ + "str" # Optional. Trials with any of + the given identifiers will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial identifiers. + ], + "phases": [ + "str" # Optional. Trials with any of + the given phases will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the phases. + ], + "purposes": [ + "str" # Optional. Trials with any of + the given purposes will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the purposes. + ], + "recruitmentStatuses": [ + "str" # Optional. Trials with any of + the given recruitment statuses will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the recruitment + statuses. + ], + "sources": [ + "str" # Optional. Trials with any of + the given sources will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the sources. + ], + "sponsors": [ + "str" # Optional. Trials with any of + the given sponsors will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the sponsors. + ], + "studyTypes": [ + "str" # Optional. Trials with any of + the given study types will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the study types. + ] + } + ] + }, + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ @overload async def begin_match_trials( - self, - body: JSON, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> AsyncLROPoller[_models.TrialMatcherResult]: + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. :param body: Required. :type body: JSON - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns TrialMatcherResult. The TrialMatcherResult - is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ @overload async def begin_match_trials( - self, - body: IO, - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> AsyncLROPoller[_models.TrialMatcherResult]: + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. :param body: Required. - :type body: IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime + :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns TrialMatcherResult. The TrialMatcherResult - is compatible with MutableMapping + :return: An instance of AsyncLROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ @distributed_trace_async async def begin_match_trials( - self, - body: Union[_models.TrialMatcherData, JSON, IO], - *, - repeatability_request_id: Optional[str] = None, - repeatability_first_sent: Optional[datetime.datetime] = None, - **kwargs: Any - ) -> AsyncLROPoller[_models.TrialMatcherResult]: + self, body: Union[_models.TrialMatcherData, JSON, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.TrialMatcherInferenceResult]: + # pylint: disable=line-too-long """Create Trial Matcher job. Creates a Trial Matcher job with the given request body. - :param body: Is one of the following types: TrialMatcherData, JSON, IO Required. - :type body: ~azure.healthinsights.clinicalmatching.models.TrialMatcherData or JSON or IO - :keyword repeatability_request_id: An opaque, globally-unique, client-generated string - identifier for the request. Default value is None. - :paramtype repeatability_request_id: str - :keyword repeatability_first_sent: Specifies the date and time at which the request was first - created. Default value is None. - :paramtype repeatability_first_sent: ~datetime.datetime - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword str continuation_token: A continuation token to restart a poller from a saved state. - :keyword polling: By default, your polling method will be AsyncLROBasePolling. Pass in False - for this operation to not poll, or pass in your own initialized polling object for a personal - polling strategy. - :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod - :keyword int polling_interval: Default waiting time between two polls for LRO operations if no - Retry-After header is present. - :return: An instance of AsyncLROPoller that returns TrialMatcherResult. The TrialMatcherResult - is compatible with MutableMapping + :param body: Is one of the following types: TrialMatcherData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.clinicalmatching.models.TrialMatcherData or JSON or IO[bytes] + :return: An instance of AsyncLROPoller that returns TrialMatcherInferenceResult. The + TrialMatcherInferenceResult is compatible with MutableMapping :rtype: - ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherResult] + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult] :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", # Default + value is "ResearchStudy". resourceType. Required. + "status": "str", # active | + administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | + in-review | temporarily-closed-to-accrual | + temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", + "administratively-completed", "approved", "closed-to-accrual", + "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", + "temporarily-closed-to-accrual-and-intervention", and + "withdrawn". + "arm": [ + { + "name": "str", # Label for + study arm. Required. + "description": "str", # + Optional. Short explanation of study path. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "category": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "condition": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "contact": [ + { + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "name": "str", # Optional. + Name of an individual to contact. + "telecom": [ + { + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "rank": 0, # + Optional. Specify preferred order of use (1 = + highest). + "system": + "str", # Optional. phone | fax | email | pager | + url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and + "other". + "use": "str", + # Optional. home | work | temp | old | mobile - + purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + "value": + "str" # Optional. The actual contact point + details. + } + ] + } + ], + "contained": [ + { + "resourceType": "str", # The + type of resource. Required. + "id": "str", # Optional. + Resource Id. + "implicitRules": "str", # + Optional. A set of rules under which this content was + created. + "language": "str", # + Optional. Language of the resource content. + "meta": { + "lastUpdated": "str", + # Optional. When the resource last changed - e.g. + when the version changed. + "profile": [ + "str" # + Optional. A list of profiles (references to + `StructureDefinition + `_ + resources) that this resource claims to conform + to. The URL is a reference to + `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "source": "str", # + Optional. A uri that identifies the source system of + the resource. This provides a minimal amount of + Provenance information that can be used to track or + differentiate the source of information in the + resource. The source may identify another FHIR + server, document, message, database, etc. + "tag": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # + Optional. Plain text + representation of the + concept. + }, + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it + appears in the version portion of the URL. This value + changes when the resource is created, updated, or + deleted. + } + } + ], + "description": "str", # Optional. What this + is study doing. + "enrollment": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "focus": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "id": "str", # Optional. Resource Id. + "identifier": [ + { + "assigner": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": ..., + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": ..., + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + } + ], + "implicitRules": "str", # Optional. A set of + rules under which this content was created. + "keyword": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "language": "str", # Optional. Language of + the resource content. + "location": [ + { + "coding": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": ..., + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "text": "str" # Optional. + Plain text representation of the concept. + } + ], + "meta": { + "lastUpdated": "str", # Optional. + When the resource last changed - e.g. when the version + changed. + "profile": [ + "str" # Optional. A list of + profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. The + URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "source": "str", # Optional. A uri + that identifies the source system of the resource. This + provides a minimal amount of Provenance information that can + be used to track or differentiate the source of information + in the resource. The source may identify another FHIR server, + document, message, database, etc. + "tag": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "versionId": "str" # Optional. The + version specific identifier, as it appears in the version + portion of the URL. This value changes when the resource is + created, updated, or deleted. + }, + "modifierExtension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "note": [ + { + "text": "str", # The + annotation - text content (as markdown). Required. + "authorString": "str", # + Optional. Individual responsible for the annotation. + "extension": [ + { + "url": "str", + # Source of the definition for the extension code + - a logical name or a URL. Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": + { + "high": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": + { + "denominator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by + the system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for inter-element + referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the reference + refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample points + at each time point. Required. + "origin": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal values + with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data by + this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower limit + of detection. + "upperLimit": 0.0 # Optional. Upper limit of + detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str", # Optional. + Unique id for inter-element referencing. + "time": "str" # Optional. + When the annotation was made. + } + ], + "objective": [ + { + "name": "str", # Label for + the objective. Required. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. + Text alternative for the + resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with + inclusive boundary, if + not ongoing. + "start": "str" # + Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the + identifier value. + "type": ..., + "use": "str", # Optional. + usual | official | temp | + secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, + internal or absolute URL. + "type": "str" # Optional. Type + the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + } + } + ], + "partOf": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "period": { + "end": "str", # Optional. End time + with inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "phase": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "primaryPurposeType": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "principalInvestigator": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "protocol": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "reasonStopped": { + "coding": [ + { + "code": "str", # + Optional. Symbol in syntax defined by the system. + "display": "str", # + Optional. Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": ..., + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ], + "id": "str", # + Optional. Unique id for inter-element referencing. + "system": "str", # + Optional. Identity of the terminology system. + "version": "str" # + Optional. Version of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "site": [ + { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "use": "str", # + Optional. usual | official | temp | secondary | old + (If known). + "value": "str" # + Optional. The value that is unique. + }, + "reference": "str", # + Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to (e.g. "Patient"). + } + ], + "sponsor": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "system": "str", # Optional. + The namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, # Optional. + Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value + as integer. + "valuePeriod": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": ..., + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, or + "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # Optional. + Lower limit of detection. + "upperLimit": 0.0 # Optional. + Upper limit of detection. + }, + "valueString": "str", # Optional. + Value as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "use": "str", # Optional. + usual | official | temp | secondary | old (If known). + "value": "str" # Optional. + The value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "text": { + "div": "str", # xhtml. Required. + "status": "str", # generated, + extensions, additional, empty. Required. + "extension": [ + { + "url": "str", # + Source of the definition for the extension code - a + logical name or a URL. Required. + "valueBoolean": bool, + # Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "valueDateTime": + "str", # Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", + # Optional. End time with inclusive boundary, if + not ongoing. + "start": + "str" # Optional. Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "numerator": + { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + } + }, + "valueReference": { + "display": + "str", # Optional. Text alternative for the + resource. + "identifier": + { + "assigner": ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": "str", # Optional. The namespace + for the identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", # Optional. usual | official | + temp | secondary | old (If known). + "value": "str" # Optional. The value that is + unique. + }, + "reference": + "str", # Optional. Literal reference, Relative, + internal or absolute URL. + "type": "str" + # Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": + 0, # Number of sample points at each time point. + Required. + "origin": { + "code": "str", # Optional. Coded form of the + unit. + "comparator": "str", # Optional. < | <= | >= + | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "period": + 0.0, # Number of milliseconds between samples. + Required. + "data": + "str", # Optional. Decimal values with spaces, + or "E" | "U" | "L". + "factor": + 0.0, # Optional. Multiply data by this before + adding to origin. + "lowerLimit": + 0.0, # Optional. Lower limit of detection. + "upperLimit": + 0.0 # Optional. Upper limit of detection. + }, + "valueString": "str", + # Optional. Value as string. + "valueTime": + "12:30:00" # Optional. Value as time (hh:mm:ss). + } + ], + "id": "str" # Optional. Unique id + for inter-element referencing. + }, + "title": "str" # Optional. Name for this + study. + } + ], + "registryFilters": [ + { + "conditions": [ + "str" # Optional. Trials with any of + the given medical conditions will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the medical + conditions. + ], + "facilityAreas": [ + { + "geometry": { + "coordinates": [ + 0.0 # + Coordinates of the area circle's center, + represented according to the ``GeoJSON`` + standard. This is an array of 2 decimal numbers, + longitude and latitude (precisely in this order). + Required. + ], + "type": "str" # + ``GeoJSON`` geometry type. Required. "Point" + }, + "properties": { + "radius": 0.0, # The + radius of the area's circle, in meters. Required. + "subType": "str" # + ``GeoJSON`` object sub-type. Required. "Circle" + }, + "type": "str" # ``GeoJSON`` + type. Required. "Feature" + } + ], + "facilityLocations": [ + { + "countryOrRegion": "str", # + Country/region name. Required. + "city": "str", # Optional. + City name. + "state": "str" # Optional. + State name. + } + ], + "facilityNames": [ + "str" # Optional. Trials with any of + the given facility names will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial facility names. + ], + "ids": [ + "str" # Optional. Trials with any of + the given identifiers will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the trial identifiers. + ], + "phases": [ + "str" # Optional. Trials with any of + the given phases will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the phases. + ], + "purposes": [ + "str" # Optional. Trials with any of + the given purposes will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the purposes. + ], + "recruitmentStatuses": [ + "str" # Optional. Trials with any of + the given recruitment statuses will be included in the + selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the recruitment + statuses. + ], + "sources": [ + "str" # Optional. Trials with any of + the given sources will be included in the selection (provided + that other limitations are satisfied). Leaving this list + empty will not limit the sources. + ], + "sponsors": [ + "str" # Optional. Trials with any of + the given sponsors will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the sponsors. + ], + "studyTypes": [ + "str" # Optional. Trials with any of + the given study types will be included in the selection + (provided that other limitations are satisfied). Leaving this + list empty will not limit the study types. + ] + } + ] + }, + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Trial + Matcher inference. Required. "trialEligibility" + "value": "str", # The value of the + inference, as relevant for the given inference type. Required. + "clinicalTrialId": "str", # Optional. The + identifier of the clinical trial. + "confidenceScore": 0.0, # Optional. + Confidence score for this inference. + "description": "str", # Optional. The + description corresponding to the inference value. + "evidence": [ + { + "eligibilityCriteriaEvidence": "str", # Optional. A + piece of evidence from the eligibility criteria text of a + clinical trial. + "importance": 0.0, # + Optional. A value indicating how important this piece of + evidence is for the inference. + "patientDataEvidence": { + "id": "str", # The + identifier of the document containing the evidence. + Required. + "length": 0, # The + length of the evidence text span. Required. + "offset": 0, # The + start index of the evidence text span in the document + (0 based). Required. + "text": "str" # + Optional. The actual text span which is evidence for + the inference. + }, + "patientInfoEvidence": { + "code": "str", # The + code within the given clinical coding system. + Required. + "system": "str", # + The clinical coding system, e.g. ICD-10, SNOMED-CT, + UMLS. Required. + "name": "str", # + Optional. The name of this coded concept in the + coding system. + "value": "str" # + Optional. A value associated with the code within the + given clinical coding system. + } + } + ], + "metadata": { + "conditions": [ + "str" # Medical conditions + and their synonyms which are relevant for the clinical + trial, given as strings. Required. + ], + "contacts": [ + { + "email": "str", # + Optional. The person's email. + "name": "str", # + Optional. The person's name. + "phone": "str" # + Optional. A person's phone number. + } + ], + "facilities": [ + { + "countryOrRegion": + "str", # Country/region name. Required. + "name": "str", # The + facility's name. Required. + "city": "str", # + Optional. City name. + "state": "str" # + Optional. State name. + } + ], + "phases": [ + "str" # Optional. Phases + which are relevant for the clinical trial. Each clinical + trial can be in a certain phase or in multiple phases. + ], + "recruitmentStatus": "str", # + Optional. Possible recruitment status of a clinical trial. + Known values are: "unknownStatus", "notYetRecruiting", + "recruiting", and "enrollingByInvitation". + "sponsors": [ + "str" # Optional. + Sponsors/collaborators involved with the trial. + ], + "studyType": "str" # Optional. + Possible study types of a clinical trial. Known values are: + "interventional", "observational", "expandedAccess", and + "patientRegistries". + }, + "source": "str" # Optional. Possible sources + of a clinical trial. Known values are: "custom" and + "clinicaltrials.gov". + } + ], + "patientId": "str", # The identifier given for the patient + in the request. Required. + "neededClinicalInfo": [ + { + "code": "str", # The code within the given + clinical coding system. Required. + "system": "str", # The clinical coding + system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + "category": "str", # Optional. The + bio-medical category related to the coded concept, e.g. + Diagnosis, Symptom, Medication, Examination. + "name": "str", # Optional. The name of this + coded concept in the coding system. + "semanticType": "str", # Optional. The `UMLS + semantic type + `_ + associated with the coded concept. + "value": "str" # Optional. A value + associated with the code within the given clinical coding system. + } + ] + } + ], + "knowledgeGraphLastUpdateDate": "2020-02-20" # Optional. The date when the + clinical trials knowledge graph was last updated. + } """ _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.TrialMatcherResult] = kwargs.pop("cls", None) + cls: ClsType[_models.TrialMatcherInferenceResult] = kwargs.pop("cls", None) polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token: Optional[str] = kwargs.pop("continuation_token", None) if cont_token is None: raw_result = await self._match_trials_initial( - body=body, - repeatability_request_id=repeatability_request_id, - repeatability_first_sent=repeatability_first_sent, - content_type=content_type, - cls=lambda x, y, z: x, - headers=_headers, - params=_params, - **kwargs + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs ) kwargs.pop("error_map", None) def get_long_running_output(pipeline_response): + response_headers = {} response = pipeline_response.http_response - deserialized = _deserialize(_models.TrialMatcherResult, response.json()) + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.TrialMatcherInferenceResult, response.json().get("result")) if cls: - return cls(pipeline_response, deserialized, {}) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized path_format_arguments = { @@ -311,10 +12980,12 @@ def get_long_running_output(pipeline_response): else: polling_method = polling if cont_token: - return AsyncLROPoller.from_continuation_token( + return AsyncLROPoller[_models.TrialMatcherInferenceResult].from_continuation_token( polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output, ) - return AsyncLROPoller(self._client, raw_result, get_long_running_output, polling_method) # type: ignore + return AsyncLROPoller[_models.TrialMatcherInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/__init__.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/__init__.py index d164ec7e9a55..04a2a61c9983 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/__init__.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/__init__.py @@ -6,103 +6,165 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._models import AcceptedAge -from ._models import AcceptedAgeRange +from ._models import Annotation from ._models import AreaGeometry from ._models import AreaProperties from ._models import ClinicalCodedElement from ._models import ClinicalNoteEvidence -from ._models import ClinicalTrialDemographics -from ._models import ClinicalTrialDetails from ._models import ClinicalTrialMetadata from ._models import ClinicalTrialRegistryFilter from ._models import ClinicalTrialResearchFacility from ._models import ClinicalTrials +from ._models import CodeableConcept +from ._models import Coding +from ._models import Condition +from ._models import ConditionStage +from ._models import ContactDetail from ._models import ContactDetails +from ._models import ContactPoint +from ._models import DocumentAdministrativeMetadata +from ._models import DocumentAuthor from ._models import DocumentContent +from ._models import DomainResource +from ._models import Element +from ._models import Encounter from ._models import Error from ._models import ExtendedClinicalCodedElement +from ._models import Extension from ._models import GeographicArea from ._models import GeographicLocation +from ._models import HealthInsightsOperationStatus +from ._models import Identifier from ._models import InnerError +from ._models import Meta +from ._models import Narrative +from ._models import Observation +from ._models import ObservationComponent +from ._models import ObservationReferenceRange +from ._models import OrderedProcedure +from ._models import PatientDetails from ._models import PatientDocument -from ._models import PatientInfo from ._models import PatientRecord +from ._models import Period +from ._models import Quantity +from ._models import Range +from ._models import Ratio +from ._models import Reference +from ._models import ResearchStudy +from ._models import ResearchStudyArm +from ._models import ResearchStudyObjective +from ._models import Resource +from ._models import SampledData +from ._models import TimePeriod from ._models import TrialMatcherData from ._models import TrialMatcherInference from ._models import TrialMatcherInferenceEvidence +from ._models import TrialMatcherInferenceResult from ._models import TrialMatcherModelConfiguration from ._models import TrialMatcherPatientResult -from ._models import TrialMatcherResult -from ._models import TrialMatcherResults -from ._enums import AgeUnit from ._enums import ClinicalDocumentType -from ._enums import ClinicalTrialAcceptedSex from ._enums import ClinicalTrialPhase from ._enums import ClinicalTrialPurpose from ._enums import ClinicalTrialRecruitmentStatus from ._enums import ClinicalTrialSource from ._enums import ClinicalTrialStudyType +from ._enums import ContactPointSystem +from ._enums import ContactPointUse from ._enums import DocumentContentSourceType from ._enums import DocumentType +from ._enums import EncounterClass from ._enums import GeoJsonGeometryType from ._enums import GeoJsonPropertiesSubType from ._enums import GeoJsonType from ._enums import JobStatus -from ._enums import PatientInfoSex -from ._enums import RepeatabilityResultType +from ._enums import ObservationStatusCodeType +from ._enums import PatientSex +from ._enums import RepeatabilityResult +from ._enums import ResearchStudyStatusCodeType +from ._enums import SpecialtyType from ._enums import TrialMatcherInferenceType from ._patch import __all__ as _patch_all from ._patch import * # pylint: disable=unused-wildcard-import from ._patch import patch_sdk as _patch_sdk __all__ = [ - "AcceptedAge", - "AcceptedAgeRange", + "Annotation", "AreaGeometry", "AreaProperties", "ClinicalCodedElement", "ClinicalNoteEvidence", - "ClinicalTrialDemographics", - "ClinicalTrialDetails", "ClinicalTrialMetadata", "ClinicalTrialRegistryFilter", "ClinicalTrialResearchFacility", "ClinicalTrials", + "CodeableConcept", + "Coding", + "Condition", + "ConditionStage", + "ContactDetail", "ContactDetails", + "ContactPoint", + "DocumentAdministrativeMetadata", + "DocumentAuthor", "DocumentContent", + "DomainResource", + "Element", + "Encounter", "Error", "ExtendedClinicalCodedElement", + "Extension", "GeographicArea", "GeographicLocation", + "HealthInsightsOperationStatus", + "Identifier", "InnerError", + "Meta", + "Narrative", + "Observation", + "ObservationComponent", + "ObservationReferenceRange", + "OrderedProcedure", + "PatientDetails", "PatientDocument", - "PatientInfo", "PatientRecord", + "Period", + "Quantity", + "Range", + "Ratio", + "Reference", + "ResearchStudy", + "ResearchStudyArm", + "ResearchStudyObjective", + "Resource", + "SampledData", + "TimePeriod", "TrialMatcherData", "TrialMatcherInference", "TrialMatcherInferenceEvidence", + "TrialMatcherInferenceResult", "TrialMatcherModelConfiguration", "TrialMatcherPatientResult", - "TrialMatcherResult", - "TrialMatcherResults", - "AgeUnit", "ClinicalDocumentType", - "ClinicalTrialAcceptedSex", "ClinicalTrialPhase", "ClinicalTrialPurpose", "ClinicalTrialRecruitmentStatus", "ClinicalTrialSource", "ClinicalTrialStudyType", + "ContactPointSystem", + "ContactPointUse", "DocumentContentSourceType", "DocumentType", + "EncounterClass", "GeoJsonGeometryType", "GeoJsonPropertiesSubType", "GeoJsonType", "JobStatus", - "PatientInfoSex", - "RepeatabilityResultType", + "ObservationStatusCodeType", + "PatientSex", + "RepeatabilityResult", + "ResearchStudyStatusCodeType", + "SpecialtyType", "TrialMatcherInferenceType", ] __all__.extend([p for p in _patch_all if p not in __all__]) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_enums.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_enums.py index aaf819fec7af..50f8fce95811 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_enums.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_enums.py @@ -10,35 +10,17 @@ from azure.core import CaseInsensitiveEnumMeta -class AgeUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Possible units for a person's age.""" - - YEARS = "years" - MONTHS = "months" - DAYS = "days" - - class ClinicalDocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): """The type of the clinical document.""" CONSULTATION = "consultation" DISCHARGE_SUMMARY = "dischargeSummary" HISTORY_AND_PHYSICAL = "historyAndPhysical" + RADIOLOGY_REPORT = "radiologyReport" PROCEDURE = "procedure" PROGRESS = "progress" - IMAGING = "imaging" LABORATORY = "laboratory" - PATHOLOGY = "pathology" - - -class ClinicalTrialAcceptedSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Possible values for the Sex eligibility criterion as accepted by clinical trials, which - indicates the sex of people who may participate in a clinical study. - """ - - ALL = "all" - FEMALE = "female" - MALE = "male" + PATHOLOGY_REPORT = "pathologyReport" class ClinicalTrialPhase(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -92,6 +74,44 @@ class ClinicalTrialStudyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): PATIENT_REGISTRIES = "patientRegistries" +class ContactPointSystem(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Contact Point System + see https://www.hl7.org/fhir/R4/valueset-contact-point-system.html. + """ + + PHONE = "phone" + """Phone""" + FAX = "fax" + """Fax""" + EMAIL = "email" + """Email""" + PAGER = "pager" + """Pager""" + URL = "url" + """Url""" + SMS = "sms" + """Sms""" + OTHER = "other" + """Other""" + + +class ContactPointUse(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Contact Point Use + See: http://hl7.org/fhir/ValueSet/contact-point-use. + """ + + HOME = "home" + """Home""" + WORK = "work" + """Work""" + TEMP = "temp" + """Temp""" + OLD = "old" + """Old""" + MOBILE = "mobile" + """Mobile""" + + class DocumentContentSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): """The type of the content's source. In case the source type is 'inline', the content is given as a string (for instance, text). @@ -99,7 +119,9 @@ class DocumentContentSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): """ INLINE = "inline" + """The content is given as a string (for instance, text).""" REFERENCE = "reference" + """The content is given as a URI.""" class DocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -113,6 +135,35 @@ class DocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): GENOMIC_SEQUENCING = "genomicSequencing" +class EncounterClass(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR + value set--http://....). + """ + + IN_PATIENT = "inpatient" + """A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned + to a location where patients generally stay at least overnight and provided with room, board, + and continuous nursing service.""" + AMBULATORY = "ambulatory" + """The term ambulatory usually implies that the patient has come to the location and is not + assigned to a bed. Sometimes referred to as an outpatient encounter.""" + OBSERVATION = "observation" + """An encounter where the patient usually will start in different encounter, such as one in the + emergency department but then transition to this type of encounter because they require a + significant period of treatment and monitoring to determine whether or not their condition + warrants an inpatient admission or discharge.""" + EMERGENCY = "emergency" + """A patient encounter that takes place at a dedicated healthcare service delivery location where + the patient receives immediate evaluation and treatment, provided until the patient can be + discharged or responsibility for the patient's care is transferred elsewhere (for example, the + patient could be admitted as an inpatient or transferred to another facility.""" + VIRTUAL = "virtual" + """A patient encounter where the patient is not physically present for the encounter, such as in a + telehealth encounter, phone call, or electronic communication.""" + HEALTH_HOME = "healthHome" + """Healthcare encounter that takes place in the residence of the patient or a designee""" + + class GeoJsonGeometryType(str, Enum, metaclass=CaseInsensitiveEnumMeta): """``GeoJSON`` geometry type.""" @@ -138,10 +189,38 @@ class JobStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): RUNNING = "running" SUCCEEDED = "succeeded" FAILED = "failed" - PARTIALLY_COMPLETED = "partiallyCompleted" + CANCELED = "canceled" + +class ObservationStatusCodeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Observation Status + Based on `FHIR ObservationStatus + `_. + """ -class PatientInfoSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): + REGISTERED = "registered" + """The existence of the observation is registered, but there is no result yet available.""" + PRELIMINARY = "preliminary" + """This is an initial or interim observation: data may be incomplete or unverified.""" + FINAL = "final" + """The observation is complete and verified by an authorized person.""" + AMENDED = "amended" + """Subsequent to being Final, the observation has been modified subsequent. This includes + updates/new information and corrections.""" + CORRECTED = "corrected" + """Subsequent to being Final, the observation has been modified to correct an error in the test + result.""" + CANCELLED = "cancelled" + """The observation is unavailable because the measurement was not started or not completed (also + sometimes called "aborted").""" + ENTERED_IN_ERROR = "entered-in-error" + """The observation has been withdrawn following previous final release.""" + UNKNOWN = "unknown" + """The observation status is unknown. Note that "unknown" is a value of last resort and every + attempt should be made to provide a meaningful value other than "unknown".""" + + +class PatientSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): """The patient's sex.""" FEMALE = "female" @@ -149,11 +228,59 @@ class PatientInfoSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): UNSPECIFIED = "unspecified" -class RepeatabilityResultType(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Type of RepeatabilityResultType.""" +class RepeatabilityResult(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Repeatability Result header options.""" ACCEPTED = "accepted" + """If the request was accepted and the server guarantees that the server state reflects a single + execution of the operation.""" REJECTED = "rejected" + """If the request was rejected because the combination of Repeatability-First-Sent and + Repeatability-Request-ID were invalid + or because the Repeatability-First-Sent value was outside the range of values held by the + server.""" + + +class ResearchStudyStatusCodeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """https://www.hl7.org/fhir/R4/codesystem-research-study-status.html.""" + + ACTIVE = "active" + """The study is open for accrual.""" + ADMINISTRATIVELY_COMPLETED = "administratively-completed" + """Study is completed prematurely and will not resume; patients are no longer examined nor + treated.""" + APPROVED = "approved" + """Protocol is approved by the review board.""" + CLOSED_TO_ACCRUAL = "closed-to-accrual" + """Study is closed for accrual; patients can be examined and treated.""" + CLOSED_TO_ACCRUAL_AND_INTERVENTION = "closed-to-accrual-and-intervention" + """The study is closed to accrual and intervention, i.e. the study is closed to enrollment, all + study subjects have completed treatment or intervention but are still being followed according + to the primary objective of the study.""" + COMPLETED = "completed" + """Study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study + subjects have completed treatment or intervention but are still being followed according to the + primary objective of the study.""" + DISAPPROVED = "disapproved" + """Protocol was disapproved by the review board.""" + IN_REVIEW = "in-review" + """Protocol is submitted to the review board for approval.""" + TEMPORARILY_CLOSED_TO_ACCRUAL = "temporarily-closed-to-accrual" + """The study is temporarily closed to accrual; a pause in accrual while study is reviewed, but is + expected to resume.""" + TEMPORARILY_CLOSED_TO_ACCRUAL_AND_INTERVENTION = "temporarily-closed-to-accrual-and-intervention" + """Study is temporarily closed for accrual; can be potentially resumed in the future""" + WITHDRAWN = "withdrawn" + """Protocol was withdrawn by the lead organization.""" + + +class SpecialtyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the type of the Specialty.""" + + PATHOLOGY = "pathology" + """pathology""" + RADIOLOGY = "radiology" + """radiology""" class TrialMatcherInferenceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_models.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_models.py index c9627ce32ad3..0674a65639a6 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_models.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/azure/healthinsights/clinicalmatching/models/_models.py @@ -8,39 +8,37 @@ # -------------------------------------------------------------------------- import datetime -from typing import Any, List, Mapping, Optional, TYPE_CHECKING, Union, overload +from typing import Any, Dict, List, Literal, Mapping, Optional, TYPE_CHECKING, Union, overload from .. import _model_base -from .._model_base import rest_field +from .._model_base import rest_discriminator, rest_field if TYPE_CHECKING: # pylint: disable=unused-import,ungrouped-imports from .. import models as _models -class AcceptedAge(_model_base.Model): - """A person's age, given as a number (value) and a unit (e.g. years, months). +class Element(_model_base.Model): + """The base definition for all elements contained inside a resource. + Based on `FHIR Element `_. - All required parameters must be populated in order to send to Azure. - - :ivar unit: Possible units for a person's age. Required. Known values are: "years", "months", - and "days". - :vartype unit: str or ~azure.healthinsights.clinicalmatching.models.AgeUnit - :ivar value: The number of years/months/days that represents the person's age. Required. - :vartype value: float + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] """ - unit: Union[str, "_models.AgeUnit"] = rest_field() - """Possible units for a person's age. Required. Known values are: \"years\", \"months\", and \"days\".""" - value: float = rest_field() - """The number of years/months/days that represents the person's age. Required. """ + id: Optional[str] = rest_field() + """Unique id for inter-element referencing.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" @overload def __init__( self, *, - unit: Union[str, "_models.AgeUnit"], - value: float, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, ): ... @@ -55,27 +53,40 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class AcceptedAgeRange(_model_base.Model): - """A definition of the range of ages accepted by a clinical trial. Contains a minimum age and/or a - maximum age. +class Annotation(Element): + """A text note which also contains information about who made the statement and when + Based on `FHIR Annotation `_. + + All required parameters must be populated in order to send to server. - :ivar minimum_age: A person's age, given as a number (value) and a unit (e.g. years, months). - :vartype minimum_age: ~azure.healthinsights.clinicalmatching.models.AcceptedAge - :ivar maximum_age: A person's age, given as a number (value) and a unit (e.g. years, months). - :vartype maximum_age: ~azure.healthinsights.clinicalmatching.models.AcceptedAge + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar author_string: Individual responsible for the annotation. + :vartype author_string: str + :ivar time: When the annotation was made. + :vartype time: str + :ivar text: The annotation - text content (as markdown). Required. + :vartype text: str """ - minimum_age: Optional["_models.AcceptedAge"] = rest_field(name="minimumAge") - """A person's age, given as a number (value) and a unit (e.g. years, months). """ - maximum_age: Optional["_models.AcceptedAge"] = rest_field(name="maximumAge") - """A person's age, given as a number (value) and a unit (e.g. years, months). """ + author_string: Optional[str] = rest_field(name="authorString") + """Individual responsible for the annotation.""" + time: Optional[str] = rest_field() + """When the annotation was made.""" + text: str = rest_field() + """The annotation - text content (as markdown). Required.""" @overload def __init__( self, *, - minimum_age: Optional["_models.AcceptedAge"] = None, - maximum_age: Optional["_models.AcceptedAge"] = None, + text: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + author_string: Optional[str] = None, + time: Optional[str] = None, ): ... @@ -93,7 +104,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class AreaGeometry(_model_base.Model): """``GeoJSON`` geometry, representing the area circle's center. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar type: ``GeoJSON`` geometry type. Required. "Point" :vartype type: str or ~azure.healthinsights.clinicalmatching.models.GeoJsonGeometryType @@ -108,13 +119,14 @@ class AreaGeometry(_model_base.Model): """``GeoJSON`` geometry type. Required. \"Point\"""" coordinates: List[float] = rest_field() """Coordinates of the area circle's center, represented according to the ``GeoJSON`` standard. -This is an array of 2 decimal numbers, longitude and latitude (precisely in this order). Required. """ + This is an array of 2 decimal numbers, longitude and latitude (precisely in this order). + Required.""" @overload def __init__( self, *, - type: Union[str, "_models.GeoJsonGeometryType"], # pylint: disable=redefined-builtin + type: Union[str, "_models.GeoJsonGeometryType"], coordinates: List[float], ): ... @@ -133,7 +145,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class AreaProperties(_model_base.Model): """``GeoJSON`` object properties. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar sub_type: ``GeoJSON`` object sub-type. Required. "Circle" :vartype sub_type: str or @@ -145,7 +157,7 @@ class AreaProperties(_model_base.Model): sub_type: Union[str, "_models.GeoJsonPropertiesSubType"] = rest_field(name="subType") """``GeoJSON`` object sub-type. Required. \"Circle\"""" radius: float = rest_field() - """The radius of the area's circle, in meters. Required. """ + """The radius of the area's circle, in meters. Required.""" @overload def __init__( @@ -170,7 +182,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class ClinicalCodedElement(_model_base.Model): """A piece of clinical information, expressed as a code in a clinical coding system. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar system: The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. :vartype system: str @@ -183,13 +195,13 @@ class ClinicalCodedElement(_model_base.Model): """ system: str = rest_field() - """The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. """ + """The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required.""" code: str = rest_field() - """The code within the given clinical coding system. Required. """ + """The code within the given clinical coding system. Required.""" name: Optional[str] = rest_field() - """The name of this coded concept in the coding system. """ + """The name of this coded concept in the coding system.""" value: Optional[str] = rest_field() - """A value associated with the code within the given clinical coding system. """ + """A value associated with the code within the given clinical coding system.""" @overload def __init__( @@ -216,7 +228,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class ClinicalNoteEvidence(_model_base.Model): """A piece of evidence from a clinical note (text document). - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar id: The identifier of the document containing the evidence. Required. :vartype id: str @@ -229,13 +241,13 @@ class ClinicalNoteEvidence(_model_base.Model): """ id: str = rest_field() - """The identifier of the document containing the evidence. Required. """ + """The identifier of the document containing the evidence. Required.""" text: Optional[str] = rest_field() - """The actual text span which is evidence for the inference. """ + """The actual text span which is evidence for the inference.""" offset: int = rest_field() - """The start index of the evidence text span in the document (0 based). Required. """ + """The start index of the evidence text span in the document (0 based). Required.""" length: int = rest_field() - """The length of the evidence text span. Required. """ + """The length of the evidence text span. Required.""" @overload def __init__( @@ -259,96 +271,10 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class ClinicalTrialDemographics(_model_base.Model): - """Demographic criteria for a clinical trial. - - :ivar accepted_sex: Indication of the sex of people who may participate in the clinical trial. - Known values are: "all", "female", and "male". - :vartype accepted_sex: str or - ~azure.healthinsights.clinicalmatching.models.ClinicalTrialAcceptedSex - :ivar accepted_age_range: A definition of the range of ages accepted by a clinical trial. - Contains a minimum age and/or a maximum age. - :vartype accepted_age_range: ~azure.healthinsights.clinicalmatching.models.AcceptedAgeRange - """ - - accepted_sex: Optional[Union[str, "_models.ClinicalTrialAcceptedSex"]] = rest_field(name="acceptedSex") - """Indication of the sex of people who may participate in the clinical trial. Known values are: \"all\", - \"female\", and \"male\". """ - accepted_age_range: Optional["_models.AcceptedAgeRange"] = rest_field(name="acceptedAgeRange") - """A definition of the range of ages accepted by a clinical trial. Contains a minimum age and/or a maximum age. """ - - @overload - def __init__( - self, - *, - accepted_sex: Optional[Union[str, "_models.ClinicalTrialAcceptedSex"]] = None, - accepted_age_range: Optional["_models.AcceptedAgeRange"] = None, - ): - ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - -class ClinicalTrialDetails(_model_base.Model): - """A description of a clinical trial. - - All required parameters must be populated in order to send to Azure. - - :ivar id: A given identifier for the clinical trial. Has to be unique within a list of clinical - trials. Required. - :vartype id: str - :ivar eligibility_criteria_text: The eligibility criteria of the clinical trial (inclusion and - exclusion), given as text. - :vartype eligibility_criteria_text: str - :ivar demographics: Demographic criteria for a clinical trial. - :vartype demographics: ~azure.healthinsights.clinicalmatching.models.ClinicalTrialDemographics - :ivar metadata: Trial data which is of interest to the potential participant. Required. - :vartype metadata: ~azure.healthinsights.clinicalmatching.models.ClinicalTrialMetadata - """ - - id: str = rest_field() - """A given identifier for the clinical trial. Has to be unique within a list of clinical trials. Required. """ - eligibility_criteria_text: Optional[str] = rest_field(name="eligibilityCriteriaText") - """The eligibility criteria of the clinical trial (inclusion and exclusion), given as text. """ - demographics: Optional["_models.ClinicalTrialDemographics"] = rest_field() - """Demographic criteria for a clinical trial. """ - metadata: "_models.ClinicalTrialMetadata" = rest_field() - """Trial data which is of interest to the potential participant. Required. """ - - @overload - def __init__( - self, - *, - id: str, # pylint: disable=redefined-builtin - metadata: "_models.ClinicalTrialMetadata", - eligibility_criteria_text: Optional[str] = None, - demographics: Optional["_models.ClinicalTrialDemographics"] = None, - ): - ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - class ClinicalTrialMetadata(_model_base.Model): """Trial data which is of interest to the potential participant. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar phases: Phases which are relevant for the clinical trial. Each clinical trial can be in a certain phase or in multiple phases. @@ -376,23 +302,25 @@ class ClinicalTrialMetadata(_model_base.Model): phases: Optional[List[Union[str, "_models.ClinicalTrialPhase"]]] = rest_field() """Phases which are relevant for the clinical trial. -Each clinical trial can be in a certain phase or in multiple phases. """ + Each clinical trial can be in a certain phase or in multiple phases.""" study_type: Optional[Union[str, "_models.ClinicalTrialStudyType"]] = rest_field(name="studyType") - """Possible study types of a clinical trial. Known values are: \"interventional\", \"observational\", - \"expandedAccess\", and \"patientRegistries\". """ + """Possible study types of a clinical trial. Known values are: \"interventional\", + \"observational\", \"expandedAccess\", and \"patientRegistries\".""" recruitment_status: Optional[Union[str, "_models.ClinicalTrialRecruitmentStatus"]] = rest_field( name="recruitmentStatus" ) - """Possible recruitment status of a clinical trial. Known values are: \"unknownStatus\", \"notYetRecruiting\", - \"recruiting\", and \"enrollingByInvitation\". """ + """Possible recruitment status of a clinical trial. Known values are: \"unknownStatus\", + \"notYetRecruiting\", \"recruiting\", and \"enrollingByInvitation\".""" conditions: List[str] = rest_field() - """Medical conditions and their synonyms which are relevant for the clinical trial, given as strings. Required. """ + """Medical conditions and their synonyms which are relevant for the clinical trial, given as + strings. Required.""" sponsors: Optional[List[str]] = rest_field() - """Sponsors/collaborators involved with the trial. """ + """Sponsors/collaborators involved with the trial.""" contacts: Optional[List["_models.ContactDetails"]] = rest_field() - """Contact details of the trial administrators, for patients that want to participate in the trial. """ + """Contact details of the trial administrators, for patients that want to participate in the + trial.""" facilities: Optional[List["_models.ClinicalTrialResearchFacility"]] = rest_field() - """Research facilities where the clinical trial is conducted. """ + """Research facilities where the clinical trial is conducted.""" @overload def __init__( @@ -475,40 +403,51 @@ class ClinicalTrialRegistryFilter(_model_base.Model): # pylint: disable=too-man """ conditions: Optional[List[str]] = rest_field() - """Trials with any of the given medical conditions will be included in the selection (provided that other - limitations are satisfied). Leaving this list empty will not limit the medical conditions. """ + """Trials with any of the given medical conditions will be included in the selection (provided + that other limitations are satisfied). + Leaving this list empty will not limit the medical conditions.""" study_types: Optional[List[Union[str, "_models.ClinicalTrialStudyType"]]] = rest_field(name="studyTypes") - """Trials with any of the given study types will be included in the selection (provided that other limitations - are satisfied). Leaving this list empty will not limit the study types. """ + """Trials with any of the given study types will be included in the selection (provided that other + limitations are satisfied). + Leaving this list empty will not limit the study types.""" recruitment_statuses: Optional[List[Union[str, "_models.ClinicalTrialRecruitmentStatus"]]] = rest_field( name="recruitmentStatuses" ) - """Trials with any of the given recruitment statuses will be included in the selection (provided that other - limitations are satisfied). Leaving this list empty will not limit the recruitment statuses. """ + """Trials with any of the given recruitment statuses will be included in the selection (provided + that other limitations are satisfied). + Leaving this list empty will not limit the recruitment statuses.""" sponsors: Optional[List[str]] = rest_field() - """Trials with any of the given sponsors will be included in the selection (provided that other limitations are - satisfied). Leaving this list empty will not limit the sponsors. """ + """Trials with any of the given sponsors will be included in the selection (provided that other + limitations are satisfied). + Leaving this list empty will not limit the sponsors.""" phases: Optional[List[Union[str, "_models.ClinicalTrialPhase"]]] = rest_field() - """Trials with any of the given phases will be included in the selection (provided that other limitations are - satisfied). Leaving this list empty will not limit the phases. """ + """Trials with any of the given phases will be included in the selection (provided that other + limitations are satisfied). + Leaving this list empty will not limit the phases.""" purposes: Optional[List[Union[str, "_models.ClinicalTrialPurpose"]]] = rest_field() - """Trials with any of the given purposes will be included in the selection (provided that other limitations are - satisfied). Leaving this list empty will not limit the purposes. """ + """Trials with any of the given purposes will be included in the selection (provided that other + limitations are satisfied). + Leaving this list empty will not limit the purposes.""" ids: Optional[List[str]] = rest_field() - """Trials with any of the given identifiers will be included in the selection (provided that other limitations - are satisfied). Leaving this list empty will not limit the trial identifiers. """ + """Trials with any of the given identifiers will be included in the selection (provided that other + limitations are satisfied). + Leaving this list empty will not limit the trial identifiers.""" sources: Optional[List[Union[str, "_models.ClinicalTrialSource"]]] = rest_field() - """Trials with any of the given sources will be included in the selection (provided that other limitations are - satisfied). Leaving this list empty will not limit the sources. """ + """Trials with any of the given sources will be included in the selection (provided that other + limitations are satisfied). + Leaving this list empty will not limit the sources.""" facility_names: Optional[List[str]] = rest_field(name="facilityNames") - """Trials with any of the given facility names will be included in the selection (provided that other limitations - are satisfied). Leaving this list empty will not limit the trial facility names. """ + """Trials with any of the given facility names will be included in the selection (provided that + other limitations are satisfied). + Leaving this list empty will not limit the trial facility names.""" facility_locations: Optional[List["_models.GeographicLocation"]] = rest_field(name="facilityLocations") - """Trials with any of the given facility locations will be included in the selection (provided that other - limitations are satisfied). Leaving this list empty will not limit the trial facility locations. """ + """Trials with any of the given facility locations will be included in the selection (provided + that other limitations are satisfied). + Leaving this list empty will not limit the trial facility locations.""" facility_areas: Optional[List["_models.GeographicArea"]] = rest_field(name="facilityAreas") - """Trials with any of the given facility area boundaries will be included in the selection (provided that other - limitations are satisfied). Leaving this list empty will not limit the trial facility area boundaries. """ + """Trials with any of the given facility area boundaries will be included in the selection + (provided that other limitations are satisfied). + Leaving this list empty will not limit the trial facility area boundaries.""" @overload def __init__( @@ -542,7 +481,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class ClinicalTrialResearchFacility(_model_base.Model): """Details of a research facility where a clinical trial is conducted. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar name: The facility's name. Required. :vartype name: str @@ -555,13 +494,13 @@ class ClinicalTrialResearchFacility(_model_base.Model): """ name: str = rest_field() - """The facility's name. Required. """ + """The facility's name. Required.""" city: Optional[str] = rest_field() - """City name. """ + """City name.""" state: Optional[str] = rest_field() - """State name. """ + """State name.""" country_or_region: str = rest_field(name="countryOrRegion") - """Country/region name. Required. """ + """Country/region name. Required.""" @overload def __init__( @@ -592,25 +531,24 @@ class ClinicalTrials(_model_base.Model): In case both are given, the resulting trial set is a union of the two sets. :ivar custom_trials: A list of clinical trials. - :vartype custom_trials: - list[~azure.healthinsights.clinicalmatching.models.ClinicalTrialDetails] + :vartype custom_trials: list[~azure.healthinsights.clinicalmatching.models.ResearchStudy] :ivar registry_filters: A list of filters, each one creating a selection of trials from a given clinical trial registry. :vartype registry_filters: list[~azure.healthinsights.clinicalmatching.models.ClinicalTrialRegistryFilter] """ - custom_trials: Optional[List["_models.ClinicalTrialDetails"]] = rest_field(name="customTrials") - """A list of clinical trials. """ + custom_trials: Optional[List["_models.ResearchStudy"]] = rest_field(name="customTrials") + """A list of clinical trials.""" registry_filters: Optional[List["_models.ClinicalTrialRegistryFilter"]] = rest_field(name="registryFilters") """A list of filters, each one creating a selection of trials from a given -clinical trial registry. """ + clinical trial registry.""" @overload def __init__( self, *, - custom_trials: Optional[List["_models.ClinicalTrialDetails"]] = None, + custom_trials: Optional[List["_models.ResearchStudy"]] = None, registry_filters: Optional[List["_models.ClinicalTrialRegistryFilter"]] = None, ): ... @@ -626,31 +564,27 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class ContactDetails(_model_base.Model): - """A person's contact details. +class CodeableConcept(Element): + """Concept - reference to a terminology or just text + Based on `FHIR CodeableConcept `_. - :ivar name: The person's name. - :vartype name: str - :ivar email: The person's email. - :vartype email: str - :ivar phone: A person's phone number. - :vartype phone: str + :ivar coding: Code defined by a terminology system. + :vartype coding: list[~azure.healthinsights.clinicalmatching.models.Coding] + :ivar text: Plain text representation of the concept. + :vartype text: str """ - name: Optional[str] = rest_field() - """The person's name. """ - email: Optional[str] = rest_field() - """The person's email. """ - phone: Optional[str] = rest_field() - """A person's phone number. """ + coding: Optional[List["_models.Coding"]] = rest_field() + """Code defined by a terminology system.""" + text: Optional[str] = rest_field() + """Plain text representation of the concept.""" @overload def __init__( self, *, - name: Optional[str] = None, - email: Optional[str] = None, - phone: Optional[str] = None, + coding: Optional[List["_models.Coding"]] = None, + text: Optional[str] = None, ): ... @@ -665,35 +599,43 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class DocumentContent(_model_base.Model): - """The content of the patient document. +class Coding(Element): + """A Coding is a representation of a defined concept using a symbol from a defined "code system". + Based on `FHIR Coding `_. - All required parameters must be populated in order to send to Azure. - - :ivar source_type: The type of the content's source. - In case the source type is 'inline', the content is given as a string (for instance, text). - In case the source type is 'reference', the content is given as a URI. Required. Known values - are: "inline" and "reference". - :vartype source_type: str or - ~azure.healthinsights.clinicalmatching.models.DocumentContentSourceType - :ivar value: The content of the document, given either inline (as a string) or as a reference - (URI). Required. - :vartype value: str + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar system: Identity of the terminology system. + :vartype system: str + :ivar version: Version of the system - if relevant. + :vartype version: str + :ivar code: Symbol in syntax defined by the system. + :vartype code: str + :ivar display: Representation defined by the system. + :vartype display: str """ - source_type: Union[str, "_models.DocumentContentSourceType"] = rest_field(name="sourceType") - """The type of the content's source. In case the source type is 'inline', the content is given as a string (for - instance, text). In case the source type is 'reference', the content is given as a URI. Required. Known values - are: \"inline\" and \"reference\". """ - value: str = rest_field() - """The content of the document, given either inline (as a string) or as a reference (URI). Required. """ + system: Optional[str] = rest_field() + """Identity of the terminology system.""" + version: Optional[str] = rest_field() + """Version of the system - if relevant.""" + code: Optional[str] = rest_field() + """Symbol in syntax defined by the system.""" + display: Optional[str] = rest_field() + """Representation defined by the system.""" @overload def __init__( self, *, - source_type: Union[str, "_models.DocumentContentSourceType"], - value: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + system: Optional[str] = None, + version: Optional[str] = None, + code: Optional[str] = None, + display: Optional[str] = None, ): ... @@ -708,45 +650,45 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class Error(_model_base.Model): - """The error object. +class Resource(_model_base.Model): + """Resource is the ancestor of DomainResource from which most resources are derived. Bundle, + Parameters, and Binary extend Resource directly. + Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. - :ivar code: One of a server-defined set of error codes. Required. - :vartype code: str - :ivar message: A human-readable representation of the error. Required. - :vartype message: str - :ivar target: The target of the error. - :vartype target: str - :ivar details: An array of details about specific errors that led to this reported error. - Required. - :vartype details: list[~azure.healthinsights.clinicalmatching.models.Error] - :ivar innererror: An object containing more specific information than the current object about - the error. - :vartype innererror: ~azure.healthinsights.clinicalmatching.models.InnerError + :ivar resource_type: The type of resource. Required. + :vartype resource_type: str + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.clinicalmatching.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str """ - code: str = rest_field() - """One of a server-defined set of error codes. Required. """ - message: str = rest_field() - """A human-readable representation of the error. Required. """ - target: Optional[str] = rest_field() - """The target of the error. """ - details: List["_models.Error"] = rest_field() - """An array of details about specific errors that led to this reported error. Required. """ - innererror: Optional["_models.InnerError"] = rest_field() - """An object containing more specific information than the current object about the error. """ + resource_type: str = rest_field(name="resourceType") + """The type of resource. Required.""" + id: Optional[str] = rest_field() + """Resource Id.""" + meta: Optional["_models.Meta"] = rest_field() + """Metadata about the resource.""" + implicit_rules: Optional[str] = rest_field(name="implicitRules") + """A set of rules under which this content was created.""" + language: Optional[str] = rest_field() + """Language of the resource content.""" @overload def __init__( self, *, - code: str, - message: str, - details: List["_models.Error"], - target: Optional[str] = None, - innererror: Optional["_models.InnerError"] = None, + resource_type: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, ): ... @@ -761,53 +703,60 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class ExtendedClinicalCodedElement(_model_base.Model): - """A piece of clinical information, expressed as a code in a clinical coding system, extended by - semantic information. +class DomainResource(Resource): + """A resource with narrative, extensions, and contained resources + Based on `FHIR DomainResource `_. - All required parameters must be populated in order to send to Azure. + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + Condition, Observation - :ivar system: The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. - :vartype system: str - :ivar code: The code within the given clinical coding system. Required. - :vartype code: str - :ivar name: The name of this coded concept in the coding system. - :vartype name: str - :ivar value: A value associated with the code within the given clinical coding system. - :vartype value: str - :ivar semantic_type: The `UMLS semantic type - `_ associated with the - coded concept. - :vartype semantic_type: str - :ivar category: The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, - Medication, Examination. - :vartype category: str + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.clinicalmatching.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.clinicalmatching.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.clinicalmatching.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar resource_type: Required. Default value is None. + :vartype resource_type: str """ - system: str = rest_field() - """The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. """ - code: str = rest_field() - """The code within the given clinical coding system. Required. """ - name: Optional[str] = rest_field() - """The name of this coded concept in the coding system. """ - value: Optional[str] = rest_field() - """A value associated with the code within the given clinical coding system. """ - semantic_type: Optional[str] = rest_field(name="semanticType") - """The `UMLS semantic type `_ associated - with the coded concept. """ - category: Optional[str] = rest_field() - """The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, Medication, Examination. """ + __mapping__: Dict[str, _model_base.Model] = {} + text: Optional["_models.Narrative"] = rest_field() + """Text summary of the resource, for human interpretation.""" + contained: Optional[List["_models.Resource"]] = rest_field() + """Contained, inline Resources.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + modifier_extension: Optional[List["_models.Extension"]] = rest_field(name="modifierExtension") + """Extensions that cannot be ignored.""" + resource_type: str = rest_discriminator(name="resourceType") + """Required. Default value is None.""" @overload def __init__( self, *, - system: str, - code: str, - name: Optional[str] = None, - value: Optional[str] = None, - semantic_type: Optional[str] = None, - category: Optional[str] = None, + resource_type: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, ): ... @@ -822,34 +771,153 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class GeographicArea(_model_base.Model): - """A geographic area, expressed as a ``Circle`` geometry represented using a ``GeoJSON Feature`` - (see `GeoJSON spec `_ ). +class Condition(DomainResource, discriminator="Condition"): # pylint: disable=too-many-instance-attributes + """Detailed information about conditions, problems or diagnoses + Based on `FHIR Condition `_. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. - :ivar type: ``GeoJSON`` type. Required. "Feature" - :vartype type: str or ~azure.healthinsights.clinicalmatching.models.GeoJsonType - :ivar geometry: ``GeoJSON`` geometry, representing the area circle's center. Required. - :vartype geometry: ~azure.healthinsights.clinicalmatching.models.AreaGeometry - :ivar properties: ``GeoJSON`` object properties. Required. - :vartype properties: ~azure.healthinsights.clinicalmatching.models.AreaProperties + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.clinicalmatching.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.clinicalmatching.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.clinicalmatching.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "Condition". + :vartype resource_type: str + :ivar identifier: External Ids for this condition. + :vartype identifier: list[~azure.healthinsights.clinicalmatching.models.Identifier] + :ivar clinical_status: active | recurrence | relapse | inactive | remission | resolved. + :vartype clinical_status: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar verification_status: unconfirmed | provisional | differential | confirmed | refuted | + entered-in-error. + :vartype verification_status: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar category: problem-list-item | encounter-diagnosis. + :vartype category: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar severity: Subjective severity of condition. + :vartype severity: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar code: Identification of the condition, problem or diagnosis. + :vartype code: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar body_site: Anatomical location, if relevant. + :vartype body_site: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar encounter: Encounter created as part of. + :vartype encounter: ~azure.healthinsights.clinicalmatching.models.Reference + :ivar onset_date_time: Estimated or actual date, date-time, or age. + :vartype onset_date_time: str + :ivar onset_age: Estimated or actual date, date-time, or age. + :vartype onset_age: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar onset_period: Estimated or actual date, date-time, or age. + :vartype onset_period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar onset_range: Estimated or actual date, date-time, or age. + :vartype onset_range: ~azure.healthinsights.clinicalmatching.models.Range + :ivar onset_string: Estimated or actual date, date-time, or age. + :vartype onset_string: str + :ivar abatement_date_time: When in resolution/remission. + :vartype abatement_date_time: str + :ivar abatement_age: When in resolution/remission. + :vartype abatement_age: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar abatement_period: When in resolution/remission. + :vartype abatement_period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar abatement_range: When in resolution/remission. + :vartype abatement_range: ~azure.healthinsights.clinicalmatching.models.Range + :ivar abatement_string: When in resolution/remission. + :vartype abatement_string: str + :ivar recorded_date: Date record was first recorded. + :vartype recorded_date: str + :ivar stage: stge/grade, usually assessed formally. + :vartype stage: list[~azure.healthinsights.clinicalmatching.models.ConditionStage] + :ivar note: Additional information about the Condition. + :vartype note: list[~azure.healthinsights.clinicalmatching.models.Annotation] """ - type: Union[str, "_models.GeoJsonType"] = rest_field() # pylint: disable=redefined-builtin - """``GeoJSON`` type. Required. \"Feature\"""" - geometry: "_models.AreaGeometry" = rest_field() - """``GeoJSON`` geometry, representing the area circle's center. Required. """ - properties: "_models.AreaProperties" = rest_field() - """``GeoJSON`` object properties. Required. """ + resource_type: Literal["Condition"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"Condition\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """External Ids for this condition.""" + clinical_status: Optional["_models.CodeableConcept"] = rest_field(name="clinicalStatus") + """active | recurrence | relapse | inactive | remission | resolved.""" + verification_status: Optional["_models.CodeableConcept"] = rest_field(name="verificationStatus") + """unconfirmed | provisional | differential | confirmed | refuted | entered-in-error.""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """problem-list-item | encounter-diagnosis.""" + severity: Optional["_models.CodeableConcept"] = rest_field() + """Subjective severity of condition.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Identification of the condition, problem or diagnosis.""" + body_site: Optional[List["_models.CodeableConcept"]] = rest_field(name="bodySite") + """Anatomical location, if relevant.""" + encounter: Optional["_models.Reference"] = rest_field() + """Encounter created as part of.""" + onset_date_time: Optional[str] = rest_field(name="onsetDateTime") + """Estimated or actual date, date-time, or age.""" + onset_age: Optional["_models.Quantity"] = rest_field(name="onsetAge") + """Estimated or actual date, date-time, or age.""" + onset_period: Optional["_models.Period"] = rest_field(name="onsetPeriod") + """Estimated or actual date, date-time, or age.""" + onset_range: Optional["_models.Range"] = rest_field(name="onsetRange") + """Estimated or actual date, date-time, or age.""" + onset_string: Optional[str] = rest_field(name="onsetString") + """Estimated or actual date, date-time, or age.""" + abatement_date_time: Optional[str] = rest_field(name="abatementDateTime") + """When in resolution/remission.""" + abatement_age: Optional["_models.Quantity"] = rest_field(name="abatementAge") + """When in resolution/remission.""" + abatement_period: Optional["_models.Period"] = rest_field(name="abatementPeriod") + """When in resolution/remission.""" + abatement_range: Optional["_models.Range"] = rest_field(name="abatementRange") + """When in resolution/remission.""" + abatement_string: Optional[str] = rest_field(name="abatementString") + """When in resolution/remission.""" + recorded_date: Optional[str] = rest_field(name="recordedDate") + """Date record was first recorded.""" + stage: Optional[List["_models.ConditionStage"]] = rest_field() + """stge/grade, usually assessed formally.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Additional information about the Condition.""" @overload def __init__( self, *, - type: Union[str, "_models.GeoJsonType"], # pylint: disable=redefined-builtin - geometry: "_models.AreaGeometry", - properties: "_models.AreaProperties", + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + clinical_status: Optional["_models.CodeableConcept"] = None, + verification_status: Optional["_models.CodeableConcept"] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + severity: Optional["_models.CodeableConcept"] = None, + code: Optional["_models.CodeableConcept"] = None, + body_site: Optional[List["_models.CodeableConcept"]] = None, + encounter: Optional["_models.Reference"] = None, + onset_date_time: Optional[str] = None, + onset_age: Optional["_models.Quantity"] = None, + onset_period: Optional["_models.Period"] = None, + onset_range: Optional["_models.Range"] = None, + onset_string: Optional[str] = None, + abatement_date_time: Optional[str] = None, + abatement_age: Optional["_models.Quantity"] = None, + abatement_period: Optional["_models.Period"] = None, + abatement_range: Optional["_models.Range"] = None, + abatement_string: Optional[str] = None, + recorded_date: Optional[str] = None, + stage: Optional[List["_models.ConditionStage"]] = None, + note: Optional[List["_models.Annotation"]] = None, ): ... @@ -861,40 +929,30 @@ def __init__(self, mapping: Mapping[str, Any]): """ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - + super().__init__(*args, resource_type="Condition", **kwargs) -class GeographicLocation(_model_base.Model): - """A location given as a combination of city, state and country/region. It could specify a city, a - state or a country/region. - In case a city is specified, either state +country/region or country/region (for - countries/regions where there are no states) should be added. - In case a state is specified (without a city), country/region should be added. - All required parameters must be populated in order to send to Azure. +class ConditionStage(_model_base.Model): + """Stage/grade, usually assessed formally + Based on `FHIR Condition.Stage `_. - :ivar city: City name. - :vartype city: str - :ivar state: State name. - :vartype state: str - :ivar country_or_region: Country/region name. Required. - :vartype country_or_region: str + :ivar summary: Simple summary (disease specific). + :vartype summary: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar type: Kind of staging. + :vartype type: ~azure.healthinsights.clinicalmatching.models.CodeableConcept """ - city: Optional[str] = rest_field() - """City name. """ - state: Optional[str] = rest_field() - """State name. """ - country_or_region: str = rest_field(name="countryOrRegion") - """Country/region name. Required. """ + summary: Optional["_models.CodeableConcept"] = rest_field() + """Simple summary (disease specific).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Kind of staging.""" @overload def __init__( self, *, - country_or_region: str, - city: Optional[str] = None, - state: Optional[str] = None, + summary: Optional["_models.CodeableConcept"] = None, + type: Optional["_models.CodeableConcept"] = None, ): ... @@ -909,30 +967,32 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class InnerError(_model_base.Model): - """An object containing more specific information about the error. As per Microsoft One API - guidelines - - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. +class ContactDetail(Element): + """Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail). - All required parameters must be populated in order to send to Azure. - - :ivar code: One of a server-defined set of error codes. Required. - :vartype code: str - :ivar innererror: Inner error. - :vartype innererror: ~azure.healthinsights.clinicalmatching.models.InnerError + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar name: Name of an individual to contact. + :vartype name: str + :ivar telecom: Contact details for individual or organization. + :vartype telecom: list[~azure.healthinsights.clinicalmatching.models.ContactPoint] """ - code: str = rest_field() - """One of a server-defined set of error codes. Required. """ - innererror: Optional["_models.InnerError"] = rest_field() - """Inner error. """ + name: Optional[str] = rest_field() + """Name of an individual to contact.""" + telecom: Optional[List["_models.ContactPoint"]] = rest_field() + """Contact details for individual or organization.""" @overload def __init__( self, *, - code: str, - innererror: Optional["_models.InnerError"] = None, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + name: Optional[str] = None, + telecom: Optional[List["_models.ContactPoint"]] = None, ): ... @@ -947,57 +1007,1532 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class PatientDocument(_model_base.Model): - """A clinical document related to a patient. Document here is in the wide sense - not just a text - document (note). - - All required parameters must be populated in order to send to Azure. +class ContactDetails(_model_base.Model): + """A person's contact details. - :ivar type: The type of the patient document, such as 'note' (text document) or 'fhirBundle' - (FHIR JSON document). Required. Known values are: "note", "fhirBundle", "dicom", and - "genomicSequencing". - :vartype type: str or ~azure.healthinsights.clinicalmatching.models.DocumentType - :ivar clinical_type: The type of the clinical document. Known values are: "consultation", - "dischargeSummary", "historyAndPhysical", "procedure", "progress", "imaging", "laboratory", and - "pathology". - :vartype clinical_type: str or - ~azure.healthinsights.clinicalmatching.models.ClinicalDocumentType - :ivar id: A given identifier for the document. Has to be unique across all documents for a - single patient. Required. - :vartype id: str - :ivar language: A 2 letter ISO 639-1 representation of the language of the document. - :vartype language: str - :ivar created_date_time: The date and time when the document was created. - :vartype created_date_time: ~datetime.datetime - :ivar content: The content of the patient document. Required. - :vartype content: ~azure.healthinsights.clinicalmatching.models.DocumentContent + :ivar name: The person's name. + :vartype name: str + :ivar email: The person's email. + :vartype email: str + :ivar phone: A person's phone number. + :vartype phone: str """ - type: Union[str, "_models.DocumentType"] = rest_field() # pylint: disable=redefined-builtin - """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document). - Required. Known values are: \"note\", \"fhirBundle\", \"dicom\", and \"genomicSequencing\". """ - clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = rest_field(name="clinicalType") - """The type of the clinical document. Known values are: \"consultation\", \"dischargeSummary\", - \"historyAndPhysical\", \"procedure\", \"progress\", \"imaging\", \"laboratory\", and \"pathology\". """ - id: str = rest_field() - """A given identifier for the document. Has to be unique across all documents for a single patient. Required. """ - language: Optional[str] = rest_field() - """A 2 letter ISO 639-1 representation of the language of the document. """ - created_date_time: Optional[datetime.datetime] = rest_field(name="createdDateTime") - """The date and time when the document was created. """ - content: "_models.DocumentContent" = rest_field() - """The content of the patient document. Required. """ + name: Optional[str] = rest_field() + """The person's name.""" + email: Optional[str] = rest_field() + """The person's email.""" + phone: Optional[str] = rest_field() + """A person's phone number.""" @overload def __init__( self, *, - type: Union[str, "_models.DocumentType"], # pylint: disable=redefined-builtin - id: str, # pylint: disable=redefined-builtin - content: "_models.DocumentContent", + name: Optional[str] = None, + email: Optional[str] = None, + phone: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ContactPoint(_model_base.Model): + """Details for all kinds of technology mediated contact points for a person or organization, + including telephone, email, etc. + See https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint. + + :ivar system: phone | fax | email | pager | url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and "other". + :vartype system: str or ~azure.healthinsights.clinicalmatching.models.ContactPointSystem + :ivar value: The actual contact point details. + :vartype value: str + :ivar use: home | work | temp | old | mobile - purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + :vartype use: str or ~azure.healthinsights.clinicalmatching.models.ContactPointUse + :ivar rank: Specify preferred order of use (1 = highest). + :vartype rank: int + :ivar period: Time period when the contact point was/is in use. + :vartype period: ~azure.healthinsights.clinicalmatching.models.Period + """ + + system: Optional[Union[str, "_models.ContactPointSystem"]] = rest_field() + """phone | fax | email | pager | url | sms | other. Known values are: \"phone\", \"fax\", + \"email\", \"pager\", \"url\", \"sms\", and \"other\".""" + value: Optional[str] = rest_field() + """The actual contact point details.""" + use: Optional[Union[str, "_models.ContactPointUse"]] = rest_field() + """home | work | temp | old | mobile - purpose of this contact point. Known values are: \"home\", + \"work\", \"temp\", \"old\", and \"mobile\".""" + rank: Optional[int] = rest_field() + """Specify preferred order of use (1 = highest).""" + period: Optional["_models.Period"] = rest_field() + """Time period when the contact point was/is in use.""" + + @overload + def __init__( + self, + *, + system: Optional[Union[str, "_models.ContactPointSystem"]] = None, + value: Optional[str] = None, + use: Optional[Union[str, "_models.ContactPointUse"]] = None, + rank: Optional[int] = None, + period: Optional["_models.Period"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAdministrativeMetadata(_model_base.Model): + """Document administrative metadata. + + :ivar ordered_procedures: List of procedure information associated with the document. + :vartype ordered_procedures: + list[~azure.healthinsights.clinicalmatching.models.OrderedProcedure] + :ivar encounter_id: Reference to the encounter associated with the document. + :vartype encounter_id: str + """ + + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = rest_field(name="orderedProcedures") + """List of procedure information associated with the document.""" + encounter_id: Optional[str] = rest_field(name="encounterId") + """Reference to the encounter associated with the document.""" + + @overload + def __init__( + self, + *, + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = None, + encounter_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAuthor(_model_base.Model): + """Document author. + + :ivar id: author id. + :vartype id: str + :ivar full_name: Text representation of the full name. + :vartype full_name: str + """ + + id: Optional[str] = rest_field() + """author id.""" + full_name: Optional[str] = rest_field(name="fullName") + """Text representation of the full name.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + full_name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentContent(_model_base.Model): + """The content of the patient document. + + All required parameters must be populated in order to send to server. + + :ivar source_type: The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: "inline" and "reference". + :vartype source_type: str or + ~azure.healthinsights.clinicalmatching.models.DocumentContentSourceType + :ivar value: The content of the document, given either inline (as a string) or as a reference + (URI). Required. + :vartype value: str + """ + + source_type: Union[str, "_models.DocumentContentSourceType"] = rest_field(name="sourceType") + """The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: \"inline\" and \"reference\".""" + value: str = rest_field() + """The content of the document, given either inline (as a string) or as a reference (URI). + Required.""" + + @overload + def __init__( + self, + *, + source_type: Union[str, "_models.DocumentContentSourceType"], + value: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Encounter(_model_base.Model): + """visit/encounter information. + + All required parameters must be populated in order to send to server. + + :ivar id: The id of the visit. Required. + :vartype id: str + :ivar period: Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end + to indicate the discharge time. + :vartype period: ~azure.healthinsights.clinicalmatching.models.TimePeriod + :ivar class_property: The class of the encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + :vartype class_property: str or ~azure.healthinsights.clinicalmatching.models.EncounterClass + """ + + id: str = rest_field() + """The id of the visit. Required.""" + period: Optional["_models.TimePeriod"] = rest_field() + """Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to + indicate the discharge time.""" + class_property: Optional[Union[str, "_models.EncounterClass"]] = rest_field(name="class") + """The class of the encounter. Known values are: \"inpatient\", \"ambulatory\", \"observation\", + \"emergency\", \"virtual\", and \"healthHome\".""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + period: Optional["_models.TimePeriod"] = None, + class_property: Optional[Union[str, "_models.EncounterClass"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Error(_model_base.Model): + """The error object. + + All required parameters must be populated in order to send to server. + + :ivar code: One of a server-defined set of error codes. Required. + :vartype code: str + :ivar message: A human-readable representation of the error. Required. + :vartype message: str + :ivar target: The target of the error. + :vartype target: str + :ivar details: An array of details about specific errors that led to this reported error. + :vartype details: list[~azure.healthinsights.clinicalmatching.models.Error] + :ivar innererror: An object containing more specific information than the current object about + the error. + :vartype innererror: ~azure.healthinsights.clinicalmatching.models.InnerError + """ + + code: str = rest_field() + """One of a server-defined set of error codes. Required.""" + message: str = rest_field() + """A human-readable representation of the error. Required.""" + target: Optional[str] = rest_field() + """The target of the error.""" + details: Optional[List["_models.Error"]] = rest_field() + """An array of details about specific errors that led to this reported error.""" + innererror: Optional["_models.InnerError"] = rest_field() + """An object containing more specific information than the current object about the error.""" + + @overload + def __init__( + self, + *, + code: str, + message: str, + target: Optional[str] = None, + details: Optional[List["_models.Error"]] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ExtendedClinicalCodedElement(_model_base.Model): + """A piece of clinical information, expressed as a code in a clinical coding system, extended by + semantic information. + + All required parameters must be populated in order to send to server. + + :ivar system: The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required. + :vartype system: str + :ivar code: The code within the given clinical coding system. Required. + :vartype code: str + :ivar name: The name of this coded concept in the coding system. + :vartype name: str + :ivar value: A value associated with the code within the given clinical coding system. + :vartype value: str + :ivar semantic_type: The `UMLS semantic type + `_ associated with the + coded concept. + :vartype semantic_type: str + :ivar category: The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, + Medication, Examination. + :vartype category: str + """ + + system: str = rest_field() + """The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. Required.""" + code: str = rest_field() + """The code within the given clinical coding system. Required.""" + name: Optional[str] = rest_field() + """The name of this coded concept in the coding system.""" + value: Optional[str] = rest_field() + """A value associated with the code within the given clinical coding system.""" + semantic_type: Optional[str] = rest_field(name="semanticType") + """The `UMLS semantic type + `_ associated with the + coded concept.""" + category: Optional[str] = rest_field() + """The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, Medication, + Examination.""" + + @overload + def __init__( + self, + *, + system: str, + code: str, + name: Optional[str] = None, + value: Optional[str] = None, + semantic_type: Optional[str] = None, + category: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Extension(Element): # pylint: disable=too-many-instance-attributes + """Base for all elements + Based on `FHIR Element `_. + + All required parameters must be populated in order to send to server. + + :ivar url: Source of the definition for the extension code - a logical name or a URL. Required. + :vartype url: str + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.clinicalmatching.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.clinicalmatching.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.clinicalmatching.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.clinicalmatching.models.Reference + """ + + url: str = rest_field() + """Source of the definition for the extension code - a logical name or a URL. Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + + @overload + def __init__( + self, + *, + url: str, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class GeographicArea(_model_base.Model): + """A geographic area, expressed as a ``Circle`` geometry represented using a ``GeoJSON Feature`` + (see `GeoJSON spec `_\ ). + + All required parameters must be populated in order to send to server. + + :ivar type: ``GeoJSON`` type. Required. "Feature" + :vartype type: str or ~azure.healthinsights.clinicalmatching.models.GeoJsonType + :ivar geometry: ``GeoJSON`` geometry, representing the area circle's center. Required. + :vartype geometry: ~azure.healthinsights.clinicalmatching.models.AreaGeometry + :ivar properties: ``GeoJSON`` object properties. Required. + :vartype properties: ~azure.healthinsights.clinicalmatching.models.AreaProperties + """ + + type: Union[str, "_models.GeoJsonType"] = rest_field() + """``GeoJSON`` type. Required. \"Feature\"""" + geometry: "_models.AreaGeometry" = rest_field() + """``GeoJSON`` geometry, representing the area circle's center. Required.""" + properties: "_models.AreaProperties" = rest_field() + """``GeoJSON`` object properties. Required.""" + + @overload + def __init__( + self, + *, + type: Union[str, "_models.GeoJsonType"], + geometry: "_models.AreaGeometry", + properties: "_models.AreaProperties", + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class GeographicLocation(_model_base.Model): + """A location given as a combination of city, state and country/region. It could specify a city, a + state or a country/region. + In case a city is specified, either state +country/region or country/region (for + countries/regions where there are no states) should be added. + In case a state is specified (without a city), country/region should be added. + + All required parameters must be populated in order to send to server. + + :ivar city: City name. + :vartype city: str + :ivar state: State name. + :vartype state: str + :ivar country_or_region: Country/region name. Required. + :vartype country_or_region: str + """ + + city: Optional[str] = rest_field() + """City name.""" + state: Optional[str] = rest_field() + """State name.""" + country_or_region: str = rest_field(name="countryOrRegion") + """Country/region name. Required.""" + + @overload + def __init__( + self, + *, + country_or_region: str, + city: Optional[str] = None, + state: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class HealthInsightsOperationStatus(_model_base.Model): + """Provides status details for long running operations. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: The unique ID of the operation. Required. + :vartype id: str + :ivar status: The status of the operation. Required. Known values are: "notStarted", "running", + "succeeded", "failed", and "canceled". + :vartype status: str or ~azure.healthinsights.clinicalmatching.models.JobStatus + :ivar created_date_time: The date and time when the processing job was created. + :vartype created_date_time: ~datetime.datetime + :ivar expiration_date_time: The date and time when the processing job is set to expire. + :vartype expiration_date_time: ~datetime.datetime + :ivar last_update_date_time: The date and time when the processing job was last updated. + :vartype last_update_date_time: ~datetime.datetime + :ivar error: Error object that describes the error when status is "Failed". + :vartype error: ~azure.healthinsights.clinicalmatching.models.Error + :ivar result: The result of the operation. + :vartype result: ~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceResult + """ + + id: str = rest_field(visibility=["read"]) + """The unique ID of the operation. Required.""" + status: Union[str, "_models.JobStatus"] = rest_field(visibility=["read"]) + """The status of the operation. Required. Known values are: \"notStarted\", \"running\", + \"succeeded\", \"failed\", and \"canceled\".""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was created.""" + expiration_date_time: Optional[datetime.datetime] = rest_field( + name="expirationDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job is set to expire.""" + last_update_date_time: Optional[datetime.datetime] = rest_field( + name="lastUpdateDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was last updated.""" + error: Optional["_models.Error"] = rest_field() + """Error object that describes the error when status is \"Failed\".""" + result: Optional["_models.TrialMatcherInferenceResult"] = rest_field() + """The result of the operation.""" + + @overload + def __init__( + self, + *, + error: Optional["_models.Error"] = None, + result: Optional["_models.TrialMatcherInferenceResult"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Identifier(Element): + """An identifier intended for computation + Based on `FHIR Identifier `_. + + :ivar use: usual | official | temp | secondary | old (If known). + :vartype use: str + :ivar type: Description of identifier. + :vartype type: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar system: The namespace for the identifier value. + :vartype system: str + :ivar value: The value that is unique. + :vartype value: str + :ivar period: Time period when id is/was valid for use. + :vartype period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar assigner: Organization that issued id (may be just text). + :vartype assigner: ~azure.healthinsights.clinicalmatching.models.Reference + """ + + use: Optional[str] = rest_field() + """usual | official | temp | secondary | old (If known).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Description of identifier.""" + system: Optional[str] = rest_field() + """The namespace for the identifier value.""" + value: Optional[str] = rest_field() + """The value that is unique.""" + period: Optional["_models.Period"] = rest_field() + """Time period when id is/was valid for use.""" + assigner: Optional["_models.Reference"] = rest_field() + """Organization that issued id (may be just text).""" + + @overload + def __init__( + self, + *, + use: Optional[str] = None, + type: Optional["_models.CodeableConcept"] = None, + system: Optional[str] = None, + value: Optional[str] = None, + period: Optional["_models.Period"] = None, + assigner: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class InnerError(_model_base.Model): + """An object containing more specific information about the error. As per Microsoft One API + guidelines - + https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + + :ivar code: One of a server-defined set of error codes. + :vartype code: str + :ivar innererror: Inner error. + :vartype innererror: ~azure.healthinsights.clinicalmatching.models.InnerError + """ + + code: Optional[str] = rest_field() + """One of a server-defined set of error codes.""" + innererror: Optional["_models.InnerError"] = rest_field() + """Inner error.""" + + @overload + def __init__( + self, + *, + code: Optional[str] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Meta(_model_base.Model): + """Metadata about a resource + Based on `FHIR Meta `_. + + :ivar version_id: The version specific identifier, as it appears in the version portion of the + URL. This value changes when the resource is created, updated, or deleted. + :vartype version_id: str + :ivar last_updated: When the resource last changed - e.g. when the version changed. + :vartype last_updated: str + :ivar source: A uri that identifies the source system of the resource. This provides a minimal + amount of Provenance information that can be used to track or differentiate the source of + information in the resource. The source may identify another FHIR server, document, message, + database, etc. + :vartype source: str + :ivar profile: A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_. + :vartype profile: list[str] + :ivar security: Security labels applied to this resource. These tags connect specific resources + to the overall security policy and infrastructure. + :vartype security: list[~azure.healthinsights.clinicalmatching.models.Coding] + :ivar tag: Tags applied to this resource. Tags are intended to be used to identify and relate + resources to process and workflow, and applications are not required to consider the tags when + interpreting the meaning of a resource. + :vartype tag: list[~azure.healthinsights.clinicalmatching.models.Coding] + """ + + version_id: Optional[str] = rest_field(name="versionId") + """The version specific identifier, as it appears in the version portion of the URL. This value + changes when the resource is created, updated, or deleted.""" + last_updated: Optional[str] = rest_field(name="lastUpdated") + """When the resource last changed - e.g. when the version changed.""" + source: Optional[str] = rest_field() + """A uri that identifies the source system of the resource. This provides a minimal amount of + Provenance information that can be used to track or differentiate the source of information in + the resource. The source may identify another FHIR server, document, message, database, etc.""" + profile: Optional[List[str]] = rest_field() + """A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_.""" + security: Optional[List["_models.Coding"]] = rest_field() + """Security labels applied to this resource. These tags connect specific resources to the overall + security policy and infrastructure.""" + tag: Optional[List["_models.Coding"]] = rest_field() + """Tags applied to this resource. Tags are intended to be used to identify and relate resources to + process and workflow, and applications are not required to consider the tags when interpreting + the meaning of a resource.""" + + @overload + def __init__( + self, + *, + version_id: Optional[str] = None, + last_updated: Optional[str] = None, + source: Optional[str] = None, + profile: Optional[List[str]] = None, + security: Optional[List["_models.Coding"]] = None, + tag: Optional[List["_models.Coding"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Narrative(Element): + """Any resource that is a `DomainResource `_ may + include a human-readable narrative that contains a summary of the resource and may be used to + represent the content of the resource to a human. + Based on `FHIR Narrative `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar status: generated, extensions, additional, empty. Required. + :vartype status: str + :ivar div: xhtml. Required. + :vartype div: str + """ + + status: str = rest_field() + """generated, extensions, additional, empty. Required.""" + div: str = rest_field() + """xhtml. Required.""" + + @overload + def __init__( + self, + *, + status: str, + div: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Observation(DomainResource, discriminator="Observation"): # pylint: disable=too-many-instance-attributes + """Detailed information about observations + Based on `FHIR Observation `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.clinicalmatching.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.clinicalmatching.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.clinicalmatching.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "Observation". + :vartype resource_type: str + :ivar identifier: Business Identifier for observation. + :vartype identifier: list[~azure.healthinsights.clinicalmatching.models.Identifier] + :ivar status: registered | preliminary | final | amended +. Required. Known values are: + "registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", + and "unknown". + :vartype status: str or ~azure.healthinsights.clinicalmatching.models.ObservationStatusCodeType + :ivar category: Classification of type of observation. + :vartype category: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar code: Type of observation (code / type). Required. + :vartype code: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar subject: Who and/or what the observation is about. + :vartype subject: ~azure.healthinsights.clinicalmatching.models.Reference + :ivar encounter: Healthcare event during which this observation is made. + :vartype encounter: ~azure.healthinsights.clinicalmatching.models.Reference + :ivar effective_date_time: Clinically relevant time/time-period for observation. + :vartype effective_date_time: str + :ivar effective_period: Clinically relevant time/time-period for observation. + :vartype effective_period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar effective_instant: Clinically relevant time/time-period for observation. + :vartype effective_instant: str + :ivar issued: Date/Time this version was made available. + :vartype issued: str + :ivar value_quantity: Actual result. + :vartype value_quantity: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar value_codeable_concept: Actual result. + :vartype value_codeable_concept: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar value_string: Actual result. + :vartype value_string: str + :ivar value_boolean: Actual result. + :vartype value_boolean: bool + :ivar value_integer: Actual result. + :vartype value_integer: int + :ivar value_range: Actual result. + :vartype value_range: ~azure.healthinsights.clinicalmatching.models.Range + :ivar value_ratio: Actual result. + :vartype value_ratio: ~azure.healthinsights.clinicalmatching.models.Ratio + :ivar value_sampled_data: Actual result. + :vartype value_sampled_data: ~azure.healthinsights.clinicalmatching.models.SampledData + :ivar value_time: Actual result. + :vartype value_time: ~datetime.time + :ivar value_date_time: Actual result. + :vartype value_date_time: str + :ivar value_period: Actual result. + :vartype value_period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar data_absent_reason: Why the result is missing. + :vartype data_absent_reason: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar interpretation: High, low, normal, etc. + :vartype interpretation: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar note: Comments about the observation. + :vartype note: list[~azure.healthinsights.clinicalmatching.models.Annotation] + :ivar body_site: Observed body part. + :vartype body_site: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar method: How it was done. + :vartype method: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar reference_range: Provides guide for interpretation. + :vartype reference_range: + list[~azure.healthinsights.clinicalmatching.models.ObservationReferenceRange] + :ivar has_member: Related resource that belongs to the Observation group. + :vartype has_member: list[~azure.healthinsights.clinicalmatching.models.Reference] + :ivar derived_from: Related measurements the observation is made from. + :vartype derived_from: list[~azure.healthinsights.clinicalmatching.models.Reference] + :ivar component: Component results. + :vartype component: list[~azure.healthinsights.clinicalmatching.models.ObservationComponent] + """ + + resource_type: Literal["Observation"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"Observation\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """Business Identifier for observation.""" + status: Union[str, "_models.ObservationStatusCodeType"] = rest_field() + """registered | preliminary | final | amended +. Required. Known values are: \"registered\", + \"preliminary\", \"final\", \"amended\", \"corrected\", \"cancelled\", \"entered-in-error\", + and \"unknown\".""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """Classification of type of observation.""" + code: "_models.CodeableConcept" = rest_field() + """Type of observation (code / type). Required.""" + subject: Optional["_models.Reference"] = rest_field() + """Who and/or what the observation is about.""" + encounter: Optional["_models.Reference"] = rest_field() + """Healthcare event during which this observation is made.""" + effective_date_time: Optional[str] = rest_field(name="effectiveDateTime") + """Clinically relevant time/time-period for observation.""" + effective_period: Optional["_models.Period"] = rest_field(name="effectivePeriod") + """Clinically relevant time/time-period for observation.""" + effective_instant: Optional[str] = rest_field(name="effectiveInstant") + """Clinically relevant time/time-period for observation.""" + issued: Optional[str] = rest_field() + """Date/Time this version was made available.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Actual result.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Actual result.""" + value_string: Optional[str] = rest_field(name="valueString") + """Actual result.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Actual result.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Actual result.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Actual result.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Actual result.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Actual result.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Actual result.""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Actual result.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Actual result.""" + data_absent_reason: Optional["_models.CodeableConcept"] = rest_field(name="dataAbsentReason") + """Why the result is missing.""" + interpretation: Optional[List["_models.CodeableConcept"]] = rest_field() + """High, low, normal, etc.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Comments about the observation.""" + body_site: Optional["_models.CodeableConcept"] = rest_field(name="bodySite") + """Observed body part.""" + method: Optional["_models.CodeableConcept"] = rest_field() + """How it was done.""" + reference_range: Optional[List["_models.ObservationReferenceRange"]] = rest_field(name="referenceRange") + """Provides guide for interpretation.""" + has_member: Optional[List["_models.Reference"]] = rest_field(name="hasMember") + """Related resource that belongs to the Observation group.""" + derived_from: Optional[List["_models.Reference"]] = rest_field(name="derivedFrom") + """Related measurements the observation is made from.""" + component: Optional[List["_models.ObservationComponent"]] = rest_field() + """Component results.""" + + @overload + def __init__( + self, + *, + status: Union[str, "_models.ObservationStatusCodeType"], + code: "_models.CodeableConcept", + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + subject: Optional["_models.Reference"] = None, + encounter: Optional["_models.Reference"] = None, + effective_date_time: Optional[str] = None, + effective_period: Optional["_models.Period"] = None, + effective_instant: Optional[str] = None, + issued: Optional[str] = None, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + data_absent_reason: Optional["_models.CodeableConcept"] = None, + interpretation: Optional[List["_models.CodeableConcept"]] = None, + note: Optional[List["_models.Annotation"]] = None, + body_site: Optional["_models.CodeableConcept"] = None, + method: Optional["_models.CodeableConcept"] = None, + reference_range: Optional[List["_models.ObservationReferenceRange"]] = None, + has_member: Optional[List["_models.Reference"]] = None, + derived_from: Optional[List["_models.Reference"]] = None, + component: Optional[List["_models.ObservationComponent"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, resource_type="Observation", **kwargs) + + +class ObservationComponent(Element): # pylint: disable=too-many-instance-attributes + """Component results + Based on `FHIR Observation.component `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar code: Type of component observation (code / type). Required. + :vartype code: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.clinicalmatching.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.clinicalmatching.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.clinicalmatching.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.clinicalmatching.models.Reference + :ivar data_absent_reason: Why the component result is missing. + :vartype data_absent_reason: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar interpretation: High, low, normal, etc. + :vartype interpretation: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar reference_range: Provides guide for interpretation of component result. + :vartype reference_range: + list[~azure.healthinsights.clinicalmatching.models.ObservationReferenceRange] + """ + + code: "_models.CodeableConcept" = rest_field() + """Type of component observation (code / type). Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + data_absent_reason: Optional["_models.CodeableConcept"] = rest_field(name="dataAbsentReason") + """Why the component result is missing.""" + interpretation: Optional[List["_models.CodeableConcept"]] = rest_field() + """High, low, normal, etc.""" + reference_range: Optional[List["_models.ObservationReferenceRange"]] = rest_field(name="referenceRange") + """Provides guide for interpretation of component result.""" + + @overload + def __init__( + self, + *, + code: "_models.CodeableConcept", + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + data_absent_reason: Optional["_models.CodeableConcept"] = None, + interpretation: Optional[List["_models.CodeableConcept"]] = None, + reference_range: Optional[List["_models.ObservationReferenceRange"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ObservationReferenceRange(_model_base.Model): + """Provides guide for interpretation of component result + Based on `FHIR Observation.referenceRange `_. + + :ivar low: Low Range, if relevant. + :vartype low: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar high: High Range, if relevant. + :vartype high: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar type: Reference range qualifier. + :vartype type: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar applies_to: Reference range population. + :vartype applies_to: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar age: Applicable age range, if relevant. + :vartype age: ~azure.healthinsights.clinicalmatching.models.Range + :ivar text: Text based reference range in an observation. + :vartype text: str + """ + + low: Optional["_models.Quantity"] = rest_field() + """Low Range, if relevant.""" + high: Optional["_models.Quantity"] = rest_field() + """High Range, if relevant.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Reference range qualifier.""" + applies_to: Optional[List["_models.CodeableConcept"]] = rest_field(name="appliesTo") + """Reference range population.""" + age: Optional["_models.Range"] = rest_field() + """Applicable age range, if relevant.""" + text: Optional[str] = rest_field() + """Text based reference range in an observation.""" + + @overload + def __init__( + self, + *, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, + type: Optional["_models.CodeableConcept"] = None, + applies_to: Optional[List["_models.CodeableConcept"]] = None, + age: Optional["_models.Range"] = None, + text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OrderedProcedure(_model_base.Model): + """Procedure information. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar code: Procedure code. + :vartype code: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar description: Procedure description. + :vartype description: str + """ + + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Procedure code.""" + description: Optional[str] = rest_field() + """Procedure description.""" + + @overload + def __init__( + self, + *, + extension: Optional[List["_models.Extension"]] = None, + code: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientDetails(_model_base.Model): + """Patient structured information, including demographics and known structured clinical + information. + + :ivar sex: The patient's sex. Known values are: "female", "male", and "unspecified". + :vartype sex: str or ~azure.healthinsights.clinicalmatching.models.PatientSex + :ivar birth_date: The patient's date of birth. + :vartype birth_date: ~datetime.date + :ivar clinical_info: Known clinical information for the patient, structured. + :vartype clinical_info: list[~azure.healthinsights.clinicalmatching.models.Resource] + """ + + sex: Optional[Union[str, "_models.PatientSex"]] = rest_field() + """The patient's sex. Known values are: \"female\", \"male\", and \"unspecified\".""" + birth_date: Optional[datetime.date] = rest_field(name="birthDate") + """The patient's date of birth.""" + clinical_info: Optional[List["_models.Resource"]] = rest_field(name="clinicalInfo") + """Known clinical information for the patient, structured.""" + + @overload + def __init__( + self, + *, + sex: Optional[Union[str, "_models.PatientSex"]] = None, + birth_date: Optional[datetime.date] = None, + clinical_info: Optional[List["_models.Resource"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientDocument(_model_base.Model): + """A clinical document related to a patient. Document here is in the wide sense - not just a text + document (note). + + All required parameters must be populated in order to send to server. + + :ivar type: The type of the patient document, such as 'note' (text document) or 'fhirBundle' + (FHIR JSON document). Required. Known values are: "note", "fhirBundle", "dicom", and + "genomicSequencing". + :vartype type: str or ~azure.healthinsights.clinicalmatching.models.DocumentType + :ivar clinical_type: The type of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", "procedure", "progress", + "laboratory", and "pathologyReport". + :vartype clinical_type: str or + ~azure.healthinsights.clinicalmatching.models.ClinicalDocumentType + :ivar id: A given identifier for the document. Has to be unique across all documents for a + single patient. Required. + :vartype id: str + :ivar language: A 2 letter ISO 639-1 representation of the language of the document. + :vartype language: str + :ivar created_date_time: The date and time when the document was created. + :vartype created_date_time: ~datetime.datetime + :ivar authors: Document author(s). + :vartype authors: list[~azure.healthinsights.clinicalmatching.models.DocumentAuthor] + :ivar specialty_type: specialty type the document. Known values are: "pathology" and + "radiology". + :vartype specialty_type: str or ~azure.healthinsights.clinicalmatching.models.SpecialtyType + :ivar administrative_metadata: Administrative metadata for the document. + :vartype administrative_metadata: + ~azure.healthinsights.clinicalmatching.models.DocumentAdministrativeMetadata + :ivar content: The content of the patient document. Required. + :vartype content: ~azure.healthinsights.clinicalmatching.models.DocumentContent + """ + + type: Union[str, "_models.DocumentType"] = rest_field() + """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON + document). Required. Known values are: \"note\", \"fhirBundle\", \"dicom\", and + \"genomicSequencing\".""" + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = rest_field(name="clinicalType") + """The type of the clinical document. Known values are: \"consultation\", \"dischargeSummary\", + \"historyAndPhysical\", \"radiologyReport\", \"procedure\", \"progress\", \"laboratory\", and + \"pathologyReport\".""" + id: str = rest_field() + """A given identifier for the document. Has to be unique across all documents for a single + patient. Required.""" + language: Optional[str] = rest_field() + """A 2 letter ISO 639-1 representation of the language of the document.""" + created_date_time: Optional[datetime.datetime] = rest_field(name="createdDateTime", format="rfc3339") + """The date and time when the document was created.""" + authors: Optional[List["_models.DocumentAuthor"]] = rest_field() + """Document author(s).""" + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = rest_field(name="specialtyType") + """specialty type the document. Known values are: \"pathology\" and \"radiology\".""" + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = rest_field( + name="administrativeMetadata" + ) + """Administrative metadata for the document.""" + content: "_models.DocumentContent" = rest_field() + """The content of the patient document. Required.""" + + @overload + def __init__( + self, + *, + type: Union[str, "_models.DocumentType"], + id: str, # pylint: disable=redefined-builtin + content: "_models.DocumentContent", clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = None, language: Optional[str] = None, created_date_time: Optional[datetime.datetime] = None, + authors: Optional[List["_models.DocumentAuthor"]] = None, + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = None, + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientRecord(_model_base.Model): + """A patient record, including their clinical information and data. + + All required parameters must be populated in order to send to server. + + :ivar id: A given identifier for the patient. Has to be unique across all patients in a single + request. Required. + :vartype id: str + :ivar info: Patient structured information, including demographics and known structured + clinical information. + :vartype info: ~azure.healthinsights.clinicalmatching.models.PatientDetails + :ivar encounters: Patient encounters/visits. + :vartype encounters: list[~azure.healthinsights.clinicalmatching.models.Encounter] + :ivar patient_documents: Patient unstructured clinical data, given as documents. + :vartype patient_documents: list[~azure.healthinsights.clinicalmatching.models.PatientDocument] + """ + + id: str = rest_field() + """A given identifier for the patient. Has to be unique across all patients in a single request. + Required.""" + info: Optional["_models.PatientDetails"] = rest_field() + """Patient structured information, including demographics and known structured clinical + information.""" + encounters: Optional[List["_models.Encounter"]] = rest_field() + """Patient encounters/visits.""" + patient_documents: Optional[List["_models.PatientDocument"]] = rest_field(name="patientDocuments") + """Patient unstructured clinical data, given as documents.""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + info: Optional["_models.PatientDetails"] = None, + encounters: Optional[List["_models.Encounter"]] = None, + patient_documents: Optional[List["_models.PatientDocument"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Period(Element): + """A time period defined by a start and end date and optionally time + Based on `FHIR Period `_. + + :ivar start: Starting time with inclusive boundary. + :vartype start: str + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: str + """ + + start: Optional[str] = rest_field() + """Starting time with inclusive boundary.""" + end: Optional[str] = rest_field() + """End time with inclusive boundary, if not ongoing.""" + + @overload + def __init__( + self, + *, + start: Optional[str] = None, + end: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Quantity(Element): + """A measured or measurable amount + Based on `FHIR Quantity `_. + + :ivar value: Numerical value (with implicit precision). + :vartype value: float + :ivar comparator: < | <= | >= | > - how to understand the value. + :vartype comparator: str + :ivar unit: Unit representation. + :vartype unit: str + :ivar system: System that defines coded unit form. + :vartype system: str + :ivar code: Coded form of the unit. + :vartype code: str + """ + + value: Optional[float] = rest_field() + """Numerical value (with implicit precision).""" + comparator: Optional[str] = rest_field() + """< | <= | >= | > - how to understand the value.""" + unit: Optional[str] = rest_field() + """Unit representation.""" + system: Optional[str] = rest_field() + """System that defines coded unit form.""" + code: Optional[str] = rest_field() + """Coded form of the unit.""" + + @overload + def __init__( + self, + *, + value: Optional[float] = None, + comparator: Optional[str] = None, + unit: Optional[str] = None, + system: Optional[str] = None, + code: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Range(Element): + """A set of ordered Quantities defined by a low and high limit + Based on `FHIR Range `_. + + :ivar low: Low limit. + :vartype low: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar high: High limit. + :vartype high: ~azure.healthinsights.clinicalmatching.models.Quantity + """ + + low: Optional["_models.Quantity"] = rest_field() + """Low limit.""" + high: Optional["_models.Quantity"] = rest_field() + """High limit.""" + + @overload + def __init__( + self, + *, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, ): ... @@ -1012,33 +2547,27 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class PatientInfo(_model_base.Model): - """Patient structured information, including demographics and known structured clinical - information. +class Ratio(Element): + """A ratio of two Quantity values - a numerator and a denominator + Based on `FHIR Ratio `_. - :ivar sex: The patient's sex. Known values are: "female", "male", and "unspecified". - :vartype sex: str or ~azure.healthinsights.clinicalmatching.models.PatientInfoSex - :ivar birth_date: The patient's date of birth. - :vartype birth_date: ~datetime.date - :ivar clinical_info: Known clinical information for the patient, structured. - :vartype clinical_info: - list[~azure.healthinsights.clinicalmatching.models.ClinicalCodedElement] + :ivar numerator: Numerator value. + :vartype numerator: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar denominator: Denominator value. + :vartype denominator: ~azure.healthinsights.clinicalmatching.models.Quantity """ - sex: Optional[Union[str, "_models.PatientInfoSex"]] = rest_field() - """The patient's sex. Known values are: \"female\", \"male\", and \"unspecified\".""" - birth_date: Optional[datetime.date] = rest_field(name="birthDate") - """The patient's date of birth. """ - clinical_info: Optional[List["_models.ClinicalCodedElement"]] = rest_field(name="clinicalInfo") - """Known clinical information for the patient, structured. """ + numerator: Optional["_models.Quantity"] = rest_field() + """Numerator value.""" + denominator: Optional["_models.Quantity"] = rest_field() + """Denominator value.""" @overload def __init__( self, *, - sex: Optional[Union[str, "_models.PatientInfoSex"]] = None, - birth_date: Optional[datetime.date] = None, - clinical_info: Optional[List["_models.ClinicalCodedElement"]] = None, + numerator: Optional["_models.Quantity"] = None, + denominator: Optional["_models.Quantity"] = None, ): ... @@ -1053,35 +2582,402 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) -class PatientRecord(_model_base.Model): - """A patient record, including their clinical information and data. +class Reference(Element): + """A reference from one resource to another + Based on `FHIR Reference `_. + + :ivar reference: Literal reference, Relative, internal or absolute URL. + :vartype reference: str + :ivar type: Type the reference refers to (e.g. "Patient"). + :vartype type: str + :ivar identifier: Logical reference, when literal reference is not known. + :vartype identifier: ~azure.healthinsights.clinicalmatching.models.Identifier + :ivar display: Text alternative for the resource. + :vartype display: str + """ - All required parameters must be populated in order to send to Azure. + reference: Optional[str] = rest_field() + """Literal reference, Relative, internal or absolute URL.""" + type: Optional[str] = rest_field() + """Type the reference refers to (e.g. \"Patient\").""" + identifier: Optional["_models.Identifier"] = rest_field() + """Logical reference, when literal reference is not known.""" + display: Optional[str] = rest_field() + """Text alternative for the resource.""" - :ivar id: A given identifier for the patient. Has to be unique across all patients in a single - request. Required. + @overload + def __init__( + self, + *, + reference: Optional[str] = None, + type: Optional[str] = None, + identifier: Optional["_models.Identifier"] = None, + display: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResearchStudy(DomainResource): # pylint: disable=too-many-instance-attributes + """Detailed information about Research Study + Based on `FHIR ResearchStudy `_. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. :vartype id: str - :ivar info: Patient structured information, including demographics and known structured - clinical information. - :vartype info: ~azure.healthinsights.clinicalmatching.models.PatientInfo - :ivar data: Patient unstructured clinical data, given as documents. - :vartype data: list[~azure.healthinsights.clinicalmatching.models.PatientDocument] + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.clinicalmatching.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.clinicalmatching.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.clinicalmatching.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.clinicalmatching.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "ResearchStudy". + :vartype resource_type: str + :ivar identifier: Business Identifier for study. + :vartype identifier: list[~azure.healthinsights.clinicalmatching.models.Identifier] + :ivar title: Name for this study. + :vartype title: str + :ivar protocol: Steps followed in executing study. + :vartype protocol: list[~azure.healthinsights.clinicalmatching.models.Reference] + :ivar part_of: Part of larger study. + :vartype part_of: list[~azure.healthinsights.clinicalmatching.models.Reference] + :ivar status: active | administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | in-review | + temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", "administratively-completed", "approved", + "closed-to-accrual", "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", "temporarily-closed-to-accrual-and-intervention", + and "withdrawn". + :vartype status: str or + ~azure.healthinsights.clinicalmatching.models.ResearchStudyStatusCodeType + :ivar primary_purpose_type: treatment | prevention | diagnostic | supportive-care | screening | + health-services-research | basic-science | device-feasibility. + :vartype primary_purpose_type: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar phase: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | + phase-3 | phase-4. + :vartype phase: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar category: Classifications for the study. + :vartype category: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar focus: Drugs, devices, etc. under study. + :vartype focus: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar condition: Condition being studied. + :vartype condition: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar contact: Contact details for the study. + :vartype contact: list[~azure.healthinsights.clinicalmatching.models.ContactDetail] + :ivar keyword: Used to search for the study. + :vartype keyword: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar location: Geographic region(s) for study. + :vartype location: list[~azure.healthinsights.clinicalmatching.models.CodeableConcept] + :ivar description: What this is study doing. + :vartype description: str + :ivar enrollment: Inclusion & exclusion criteria. + :vartype enrollment: list[~azure.healthinsights.clinicalmatching.models.Reference] + :ivar period: When the study began and ended. + :vartype period: ~azure.healthinsights.clinicalmatching.models.Period + :ivar sponsor: Organization that initiates and is legally responsible for the study. + :vartype sponsor: ~azure.healthinsights.clinicalmatching.models.Reference + :ivar principal_investigator: Researcher who oversees multiple aspects of the study. + :vartype principal_investigator: ~azure.healthinsights.clinicalmatching.models.Reference + :ivar site: Facility where study activities are conducted. + :vartype site: list[~azure.healthinsights.clinicalmatching.models.Reference] + :ivar reason_stopped: accrual-goal-met | closed-due-to-toxicity | + closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design. + :vartype reason_stopped: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar note: Comments made about the study. + :vartype note: list[~azure.healthinsights.clinicalmatching.models.Annotation] + :ivar arm: Defined path through the study for a subject. + :vartype arm: list[~azure.healthinsights.clinicalmatching.models.ResearchStudyArm] + :ivar objective: A goal for the study. + :vartype objective: list[~azure.healthinsights.clinicalmatching.models.ResearchStudyObjective] """ - id: str = rest_field() - """A given identifier for the patient. Has to be unique across all patients in a single request. Required. """ - info: Optional["_models.PatientInfo"] = rest_field() - """Patient structured information, including demographics and known structured clinical information. """ - data: Optional[List["_models.PatientDocument"]] = rest_field() - """Patient unstructured clinical data, given as documents. """ + resource_type: Literal["ResearchStudy"] = rest_field(name="resourceType") + """resourceType. Required. Default value is \"ResearchStudy\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """Business Identifier for study.""" + title: Optional[str] = rest_field() + """Name for this study.""" + protocol: Optional[List["_models.Reference"]] = rest_field() + """Steps followed in executing study.""" + part_of: Optional[List["_models.Reference"]] = rest_field(name="partOf") + """Part of larger study.""" + status: Union[str, "_models.ResearchStudyStatusCodeType"] = rest_field() + """active | administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | in-review | + temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: \"active\", \"administratively-completed\", \"approved\", + \"closed-to-accrual\", \"closed-to-accrual-and-intervention\", \"completed\", \"disapproved\", + \"in-review\", \"temporarily-closed-to-accrual\", + \"temporarily-closed-to-accrual-and-intervention\", and \"withdrawn\".""" + primary_purpose_type: Optional["_models.CodeableConcept"] = rest_field(name="primaryPurposeType") + """treatment | prevention | diagnostic | supportive-care | screening | health-services-research | + basic-science | device-feasibility.""" + phase: Optional["_models.CodeableConcept"] = rest_field() + """n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | + phase-4.""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """Classifications for the study.""" + focus: Optional[List["_models.CodeableConcept"]] = rest_field() + """Drugs, devices, etc. under study.""" + condition: Optional[List["_models.CodeableConcept"]] = rest_field() + """Condition being studied.""" + contact: Optional[List["_models.ContactDetail"]] = rest_field() + """Contact details for the study.""" + keyword: Optional[List["_models.CodeableConcept"]] = rest_field() + """Used to search for the study.""" + location: Optional[List["_models.CodeableConcept"]] = rest_field() + """Geographic region(s) for study.""" + description: Optional[str] = rest_field() + """What this is study doing.""" + enrollment: Optional[List["_models.Reference"]] = rest_field() + """Inclusion & exclusion criteria.""" + period: Optional["_models.Period"] = rest_field() + """When the study began and ended.""" + sponsor: Optional["_models.Reference"] = rest_field() + """Organization that initiates and is legally responsible for the study.""" + principal_investigator: Optional["_models.Reference"] = rest_field(name="principalInvestigator") + """Researcher who oversees multiple aspects of the study.""" + site: Optional[List["_models.Reference"]] = rest_field() + """Facility where study activities are conducted.""" + reason_stopped: Optional["_models.CodeableConcept"] = rest_field(name="reasonStopped") + """accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | + temporarily-closed-per-study-design.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Comments made about the study.""" + arm: Optional[List["_models.ResearchStudyArm"]] = rest_field() + """Defined path through the study for a subject.""" + objective: Optional[List["_models.ResearchStudyObjective"]] = rest_field() + """A goal for the study.""" @overload def __init__( self, *, - id: str, # pylint: disable=redefined-builtin - info: Optional["_models.PatientInfo"] = None, - data: Optional[List["_models.PatientDocument"]] = None, + status: Union[str, "_models.ResearchStudyStatusCodeType"], + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + title: Optional[str] = None, + protocol: Optional[List["_models.Reference"]] = None, + part_of: Optional[List["_models.Reference"]] = None, + primary_purpose_type: Optional["_models.CodeableConcept"] = None, + phase: Optional["_models.CodeableConcept"] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + focus: Optional[List["_models.CodeableConcept"]] = None, + condition: Optional[List["_models.CodeableConcept"]] = None, + contact: Optional[List["_models.ContactDetail"]] = None, + keyword: Optional[List["_models.CodeableConcept"]] = None, + location: Optional[List["_models.CodeableConcept"]] = None, + description: Optional[str] = None, + enrollment: Optional[List["_models.Reference"]] = None, + period: Optional["_models.Period"] = None, + sponsor: Optional["_models.Reference"] = None, + principal_investigator: Optional["_models.Reference"] = None, + site: Optional[List["_models.Reference"]] = None, + reason_stopped: Optional["_models.CodeableConcept"] = None, + note: Optional[List["_models.Annotation"]] = None, + arm: Optional[List["_models.ResearchStudyArm"]] = None, + objective: Optional[List["_models.ResearchStudyObjective"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.resource_type: Literal["ResearchStudy"] = "ResearchStudy" + + +class ResearchStudyArm(_model_base.Model): + """ResearchStudyArm. + + All required parameters must be populated in order to send to server. + + :ivar name: Label for study arm. Required. + :vartype name: str + :ivar type: Categorization of study arm. + :vartype type: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + :ivar description: Short explanation of study path. + :vartype description: str + """ + + name: str = rest_field() + """Label for study arm. Required.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Categorization of study arm.""" + description: Optional[str] = rest_field() + """Short explanation of study path.""" + + @overload + def __init__( + self, + *, + name: str, + type: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResearchStudyObjective(_model_base.Model): + """ResearchStudyObjective. + + All required parameters must be populated in order to send to server. + + :ivar name: Label for the objective. Required. + :vartype name: str + :ivar type: primary | secondary | exploratory. + :vartype type: ~azure.healthinsights.clinicalmatching.models.CodeableConcept + """ + + name: str = rest_field() + """Label for the objective. Required.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """primary | secondary | exploratory.""" + + @overload + def __init__( + self, + *, + name: str, + type: Optional["_models.CodeableConcept"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SampledData(Element): + """A series of measurements taken by a device + Based on `FHIR SampledData `_. + + All required parameters must be populated in order to send to server. + + :ivar origin: Zero value and units. Required. + :vartype origin: ~azure.healthinsights.clinicalmatching.models.Quantity + :ivar period: Number of milliseconds between samples. Required. + :vartype period: float + :ivar factor: Multiply data by this before adding to origin. + :vartype factor: float + :ivar lower_limit: Lower limit of detection. + :vartype lower_limit: float + :ivar upper_limit: Upper limit of detection. + :vartype upper_limit: float + :ivar dimensions: Number of sample points at each time point. Required. + :vartype dimensions: int + :ivar data: Decimal values with spaces, or "E" | "U" | "L". + :vartype data: str + """ + + origin: "_models.Quantity" = rest_field() + """Zero value and units. Required.""" + period: float = rest_field() + """Number of milliseconds between samples. Required.""" + factor: Optional[float] = rest_field() + """Multiply data by this before adding to origin.""" + lower_limit: Optional[float] = rest_field(name="lowerLimit") + """Lower limit of detection.""" + upper_limit: Optional[float] = rest_field(name="upperLimit") + """Upper limit of detection.""" + dimensions: int = rest_field() + """Number of sample points at each time point. Required.""" + data: Optional[str] = rest_field() + """Decimal values with spaces, or \"E\" | \"U\" | \"L\".""" + + @overload + def __init__( + self, + *, + origin: "_models.Quantity", + period: float, + dimensions: int, + factor: Optional[float] = None, + lower_limit: Optional[float] = None, + upper_limit: Optional[float] = None, + data: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TimePeriod(_model_base.Model): + """A duration of time during which an event is happening. + + :ivar start: Starting time with inclusive boundary. + :vartype start: ~datetime.datetime + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: ~datetime.datetime + """ + + start: Optional[datetime.datetime] = rest_field(format="rfc3339") + """Starting time with inclusive boundary.""" + end: Optional[datetime.datetime] = rest_field(format="rfc3339") + """End time with inclusive boundary, if not ongoing.""" + + @overload + def __init__( + self, + *, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, ): ... @@ -1097,9 +2993,9 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class TrialMatcherData(_model_base.Model): - """TrialMatcherData. + """The body of the Trial Matcher request. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar patients: The list of patients, including their clinical information and data. Required. :vartype patients: list[~azure.healthinsights.clinicalmatching.models.PatientRecord] @@ -1109,9 +3005,9 @@ class TrialMatcherData(_model_base.Model): """ patients: List["_models.PatientRecord"] = rest_field() - """The list of patients, including their clinical information and data. Required. """ + """The list of patients, including their clinical information and data. Required.""" configuration: Optional["_models.TrialMatcherModelConfiguration"] = rest_field() - """Configuration affecting the Trial Matcher model's inference. """ + """Configuration affecting the Trial Matcher model's inference.""" @overload def __init__( @@ -1136,7 +3032,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class TrialMatcherInference(_model_base.Model): """An inference made by the Trial Matcher model regarding a patient. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar type: The type of the Trial Matcher inference. Required. "trialEligibility" :vartype type: str or ~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceType @@ -1149,8 +3045,8 @@ class TrialMatcherInference(_model_base.Model): :ivar evidence: The evidence corresponding to the inference value. :vartype evidence: list[~azure.healthinsights.clinicalmatching.models.TrialMatcherInferenceEvidence] - :ivar id: The identifier of the clinical trial. - :vartype id: str + :ivar clinical_trial_id: The identifier of the clinical trial. + :vartype clinical_trial_id: str :ivar source: Possible sources of a clinical trial. Known values are: "custom" and "clinicaltrials.gov". :vartype source: str or ~azure.healthinsights.clinicalmatching.models.ClinicalTrialSource @@ -1158,33 +3054,33 @@ class TrialMatcherInference(_model_base.Model): :vartype metadata: ~azure.healthinsights.clinicalmatching.models.ClinicalTrialMetadata """ - type: Union[str, "_models.TrialMatcherInferenceType"] = rest_field() # pylint: disable=redefined-builtin + type: Union[str, "_models.TrialMatcherInferenceType"] = rest_field() """The type of the Trial Matcher inference. Required. \"trialEligibility\"""" value: str = rest_field() - """The value of the inference, as relevant for the given inference type. Required. """ + """The value of the inference, as relevant for the given inference type. Required.""" description: Optional[str] = rest_field() - """The description corresponding to the inference value. """ + """The description corresponding to the inference value.""" confidence_score: Optional[float] = rest_field(name="confidenceScore") - """Confidence score for this inference. """ + """Confidence score for this inference.""" evidence: Optional[List["_models.TrialMatcherInferenceEvidence"]] = rest_field() - """The evidence corresponding to the inference value. """ - id: Optional[str] = rest_field() - """The identifier of the clinical trial. """ + """The evidence corresponding to the inference value.""" + clinical_trial_id: Optional[str] = rest_field(name="clinicalTrialId") + """The identifier of the clinical trial.""" source: Optional[Union[str, "_models.ClinicalTrialSource"]] = rest_field() """Possible sources of a clinical trial. Known values are: \"custom\" and \"clinicaltrials.gov\".""" metadata: Optional["_models.ClinicalTrialMetadata"] = rest_field() - """Trial data which is of interest to the potential participant. """ + """Trial data which is of interest to the potential participant.""" @overload def __init__( self, *, - type: Union[str, "_models.TrialMatcherInferenceType"], # pylint: disable=redefined-builtin + type: Union[str, "_models.TrialMatcherInferenceType"], value: str, description: Optional[str] = None, confidence_score: Optional[float] = None, evidence: Optional[List["_models.TrialMatcherInferenceEvidence"]] = None, - id: Optional[str] = None, # pylint: disable=redefined-builtin + clinical_trial_id: Optional[str] = None, source: Optional[Union[str, "_models.ClinicalTrialSource"]] = None, metadata: Optional["_models.ClinicalTrialMetadata"] = None, ): @@ -1220,14 +3116,14 @@ class TrialMatcherInferenceEvidence(_model_base.Model): """ eligibility_criteria_evidence: Optional[str] = rest_field(name="eligibilityCriteriaEvidence") - """A piece of evidence from the eligibility criteria text of a clinical trial. """ + """A piece of evidence from the eligibility criteria text of a clinical trial.""" patient_data_evidence: Optional["_models.ClinicalNoteEvidence"] = rest_field(name="patientDataEvidence") - """A piece of evidence from a clinical note (text document). """ + """A piece of evidence from a clinical note (text document).""" patient_info_evidence: Optional["_models.ClinicalCodedElement"] = rest_field(name="patientInfoEvidence") """A piece of clinical information, expressed as a code in a clinical coding -system. """ + system.""" importance: Optional[float] = rest_field() - """A value indicating how important this piece of evidence is for the inference. """ + """A value indicating how important this piece of evidence is for the inference.""" @overload def __init__( @@ -1251,10 +3147,54 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles super().__init__(*args, **kwargs) +class TrialMatcherInferenceResult(_model_base.Model): + """The inference results for the Trial Matcher request. + + All required parameters must be populated in order to send to server. + + :ivar patient_results: Results for the patients given in the request. Required. + :vartype patient_results: + list[~azure.healthinsights.clinicalmatching.models.TrialMatcherPatientResult] + :ivar model_version: The version of the model used for inference, expressed as the model date. + Required. + :vartype model_version: str + :ivar knowledge_graph_last_update_date: The date when the clinical trials knowledge graph was + last updated. + :vartype knowledge_graph_last_update_date: ~datetime.date + """ + + patient_results: List["_models.TrialMatcherPatientResult"] = rest_field(name="patientResults") + """Results for the patients given in the request. Required.""" + model_version: str = rest_field(name="modelVersion") + """The version of the model used for inference, expressed as the model date. Required.""" + knowledge_graph_last_update_date: Optional[datetime.date] = rest_field(name="knowledgeGraphLastUpdateDate") + """The date when the clinical trials knowledge graph was last updated.""" + + @overload + def __init__( + self, + *, + patient_results: List["_models.TrialMatcherPatientResult"], + model_version: str, + knowledge_graph_last_update_date: Optional[datetime.date] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + class TrialMatcherModelConfiguration(_model_base.Model): """Configuration affecting the Trial Matcher model's inference. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar verbose: An indication whether the model should produce verbose output. :vartype verbose: bool @@ -1269,23 +3209,23 @@ class TrialMatcherModelConfiguration(_model_base.Model): :vartype clinical_trials: ~azure.healthinsights.clinicalmatching.models.ClinicalTrials """ - verbose: bool = rest_field(default=False) - """An indication whether the model should produce verbose output. """ - include_evidence: bool = rest_field(name="includeEvidence", default=True) - """An indication whether the model's output should include evidence for the inferences. """ + verbose: Optional[bool] = rest_field() + """An indication whether the model should produce verbose output.""" + include_evidence: Optional[bool] = rest_field(name="includeEvidence") + """An indication whether the model's output should include evidence for the inferences.""" clinical_trials: "_models.ClinicalTrials" = rest_field(name="clinicalTrials") """The clinical trials that the patient(s) should be matched to. :code:`
`The trial -selection can be given as a list of custom clinical trials and/or a list of -filters to known clinical trial registries. In case both are given, the -resulting trial set is a union of the two sets. Required. """ + selection can be given as a list of custom clinical trials and/or a list of + filters to known clinical trial registries. In case both are given, the + resulting trial set is a union of the two sets. Required.""" @overload def __init__( self, *, clinical_trials: "_models.ClinicalTrials", - verbose: bool = False, - include_evidence: bool = True, + verbose: Optional[bool] = None, + include_evidence: Optional[bool] = None, ): ... @@ -1303,32 +3243,30 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class TrialMatcherPatientResult(_model_base.Model): """The results of the model's work for a single patient. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. - :ivar id: The identifier given for the patient in the request. Required. - :vartype id: str - :ivar inferences: The model's inferences for the given patient. Required. + :ivar patient_id: The identifier given for the patient in the request. Required. + :vartype patient_id: str + :ivar inferences: The inference results for the patient. Required. :vartype inferences: list[~azure.healthinsights.clinicalmatching.models.TrialMatcherInference] :ivar needed_clinical_info: Clinical information which is needed to provide better trial - matching results for the patient. Clinical information which is needed to provide better trial matching results for the patient. :vartype needed_clinical_info: list[~azure.healthinsights.clinicalmatching.models.ExtendedClinicalCodedElement] """ - id: str = rest_field() - """The identifier given for the patient in the request. Required. """ + patient_id: str = rest_field(name="patientId") + """The identifier given for the patient in the request. Required.""" inferences: List["_models.TrialMatcherInference"] = rest_field() - """The model's inferences for the given patient. Required. """ + """The inference results for the patient. Required.""" needed_clinical_info: Optional[List["_models.ExtendedClinicalCodedElement"]] = rest_field(name="neededClinicalInfo") - """Clinical information which is needed to provide better trial matching results for the patient. Clinical - information which is needed to provide better trial matching results for the patient. """ + """Clinical information which is needed to provide better trial matching results for the patient.""" @overload def __init__( self, *, - id: str, # pylint: disable=redefined-builtin + patient_id: str, inferences: List["_models.TrialMatcherInference"], needed_clinical_info: Optional[List["_models.ExtendedClinicalCodedElement"]] = None, ): @@ -1343,90 +3281,3 @@ def __init__(self, mapping: Mapping[str, Any]): def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) - - -class TrialMatcherResult(_model_base.Model): - """The response for the Trial Matcher request. - - Readonly variables are only populated by the server, and will be ignored when sending a request. - - All required parameters must be populated in order to send to Azure. - - :ivar job_id: A processing job identifier. Required. - :vartype job_id: str - :ivar created_date_time: The date and time when the processing job was created. Required. - :vartype created_date_time: ~datetime.datetime - :ivar expiration_date_time: The date and time when the processing job is set to expire. - Required. - :vartype expiration_date_time: ~datetime.datetime - :ivar last_update_date_time: The date and time when the processing job was last updated. - Required. - :vartype last_update_date_time: ~datetime.datetime - :ivar status: The status of the processing job. Required. Known values are: "notStarted", - "running", "succeeded", "failed", and "partiallyCompleted". - :vartype status: str or ~azure.healthinsights.clinicalmatching.models.JobStatus - :ivar errors: An array of errors, if any errors occurred during the processing job. - :vartype errors: list[~azure.healthinsights.clinicalmatching.models.Error] - :ivar results: The inference results for the Trial Matcher request. - :vartype results: ~azure.healthinsights.clinicalmatching.models.TrialMatcherResults - """ - - job_id: str = rest_field(name="jobId", readonly=True) - """A processing job identifier. Required. """ - created_date_time: datetime.datetime = rest_field(name="createdDateTime", readonly=True) - """The date and time when the processing job was created. Required. """ - expiration_date_time: datetime.datetime = rest_field(name="expirationDateTime", readonly=True) - """The date and time when the processing job is set to expire. Required. """ - last_update_date_time: datetime.datetime = rest_field(name="lastUpdateDateTime", readonly=True) - """The date and time when the processing job was last updated. Required. """ - status: Union[str, "_models.JobStatus"] = rest_field(readonly=True) - """The status of the processing job. Required. Known values are: \"notStarted\", \"running\", \"succeeded\", - \"failed\", and \"partiallyCompleted\". """ - errors: Optional[List["_models.Error"]] = rest_field(readonly=True) - """An array of errors, if any errors occurred during the processing job. """ - results: Optional["_models.TrialMatcherResults"] = rest_field(readonly=True) - """The inference results for the Trial Matcher request. """ - - -class TrialMatcherResults(_model_base.Model): - """The inference results for the Trial Matcher request. - - All required parameters must be populated in order to send to Azure. - - :ivar patients: Results for the patients given in the request. Required. - :vartype patients: - list[~azure.healthinsights.clinicalmatching.models.TrialMatcherPatientResult] - :ivar model_version: The version of the model used for inference, expressed as the model date. - Required. - :vartype model_version: str - :ivar knowledge_graph_last_update_date: The date when the clinical trials knowledge graph was - last updated. - :vartype knowledge_graph_last_update_date: ~datetime.date - """ - - patients: List["_models.TrialMatcherPatientResult"] = rest_field() - """Results for the patients given in the request. Required. """ - model_version: str = rest_field(name="modelVersion") - """The version of the model used for inference, expressed as the model date. Required. """ - knowledge_graph_last_update_date: Optional[datetime.date] = rest_field(name="knowledgeGraphLastUpdateDate") - """The date when the clinical trials knowledge graph was last updated. """ - - @overload - def __init__( - self, - *, - patients: List["_models.TrialMatcherPatientResult"], - model_version: str, - knowledge_graph_last_update_date: Optional[datetime.date] = None, - ): - ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_fhir_async.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_fhir_async.py index b58c06ef5729..29b1925c14c6 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_fhir_async.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_fhir_async.py @@ -41,8 +41,7 @@ async def match_trials_async(self) -> None: # Create aTrial Matcher client # - trial_matcher_client = ClinicalMatchingClient(endpoint=ENDPOINT, - credential=AzureKeyCredential(KEY)) + trial_matcher_client = ClinicalMatchingClient(endpoint=ENDPOINT, credential=AzureKeyCredential(KEY)) # # Construct Patient @@ -59,9 +58,9 @@ async def match_trials_async(self) -> None: # Specify the clinical trial registry source as ClinicalTrials.Gov registry_filters.sources = [models.ClinicalTrialSource.CLINICALTRIALS_GOV] # Limit the clinical trial to a certain location, in this case California, USA - registry_filters.facility_locations = [models.GeographicLocation(country_or_region="United States", - city="Gilbert", - state="Arizona")] + registry_filters.facility_locations = [ + models.GeographicLocation(country_or_region="United States", city="Gilbert", state="Arizona") + ] # Limit the trial to a specific study type, interventional registry_filters.study_types = [models.ClinicalTrialStudyType.INTERVENTIONAL] @@ -100,19 +99,21 @@ def print_results(trial_matcher_result): def get_patient_from_fhir_patient(self) -> models.PatientRecord: patient_info = models.PatientInfo(sex=models.PatientInfoSex.MALE, birth_date=datetime.date(1965, 12, 26)) - patient_data = models.PatientDocument(type=models.DocumentType.FHIR_BUNDLE, - id="Consultation-14-Demo", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=self.get_patient_doc_content()), - clinical_type=models.ClinicalDocumentType.CONSULTATION) + patient_data = models.PatientDocument( + type=models.DocumentType.FHIR_BUNDLE, + id="Consultation-14-Demo", + content=models.DocumentContent( + source_type=models.DocumentContentSourceType.INLINE, value=self.get_patient_doc_content() + ), + clinical_type=models.ClinicalDocumentType.CONSULTATION, + ) return models.PatientRecord(id="patient_id", info=patient_info, data=[patient_data]) @staticmethod def get_patient_doc_content() -> str: samples_dir = os.path.dirname(os.path.realpath(__file__)) data_location = os.path.join(samples_dir, "../sample_data/match_trial_fhir_data.json") - with open(data_location, 'r', encoding='utf-8-sig') as f: + with open(data_location, "r", encoding="utf-8-sig") as f: content = f.read() return content diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_structured_coded_elements_async.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_structured_coded_elements_async.py index 5347b105c4cc..836e4df9fc32 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_structured_coded_elements_async.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/async_samples/sample_match_trials_structured_coded_elements_async.py @@ -38,59 +38,63 @@ async def match_trials_async(self) -> None: # Create a Trial Matcher client # - trial_matcher_client = ClinicalMatchingClient(endpoint=ENDPOINT, - credential=AzureKeyCredential(KEY)) + trial_matcher_client = ClinicalMatchingClient(endpoint=ENDPOINT, credential=AzureKeyCredential(KEY)) # # Create clinical info list # - clinical_info_list = [models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0006826", - name="Malignant Neoplasms", - value="true"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C1522449", - name="Therapeutic radiology procedure", - value="true"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="METASTATIC", - name="metastatic", - value="true"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C1512162", - name="Eastern Cooperative Oncology Group", - value="1"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0019693", - name="HIV Infections", - value="false"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C1300072", - name="Tumor stage", - value="2"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0019163", - name="Hepatitis B", - value="false"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0018802", - name="Congestive heart failure", - value="true"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0019196", - name="Hepatitis C", - value="false"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0220650", - name="Metastatic malignant neoplasm to brain", - value="true")] + clinical_info_list = [ + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C0006826", name="Malignant Neoplasms", value="true" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", + code="C1522449", + name="Therapeutic radiology procedure", + value="true", + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="METASTATIC", name="metastatic", value="true" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", + code="C1512162", + name="Eastern Cooperative Oncology Group", + value="1", + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C0019693", name="HIV Infections", value="false" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C1300072", name="Tumor stage", value="2" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C0019163", name="Hepatitis B", value="false" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", + code="C0018802", + name="Congestive heart failure", + value="true", + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C0019196", name="Hepatitis C", value="false" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", + code="C0220650", + name="Metastatic malignant neoplasm to brain", + value="true", + ), + ] # # Construct Patient # - patient_info = models.PatientInfo(sex=models.PatientInfoSex.MALE, birth_date=datetime.date(1965, 12, 26), - clinical_info=clinical_info_list) + patient_info = models.PatientInfo( + sex=models.PatientInfoSex.MALE, birth_date=datetime.date(1965, 12, 26), clinical_info=clinical_info_list + ) patient1 = models.PatientRecord(id="patient_id", info=patient_info) # @@ -103,9 +107,9 @@ async def match_trials_async(self) -> None: # Specify the clinical trial registry source as ClinicalTrials.Gov registry_filters.sources = [models.ClinicalTrialSource.CLINICALTRIALS_GOV] # Limit the clinical trial to a certain location, in this case California, USA - registry_filters.facility_locations = [models.GeographicLocation(country_or_region="United States", - city="Gilbert", - state="Arizona")] + registry_filters.facility_locations = [ + models.GeographicLocation(country_or_region="United States", city="Gilbert", state="Arizona") + ] # Limit the trial to a specific study type, interventional registry_filters.study_types = [models.ClinicalTrialStudyType.INTERVENTIONAL] diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_fhir.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_fhir.py index 7cf643015e18..af14ec3fc323 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_fhir.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_fhir.py @@ -57,7 +57,8 @@ def match_trials(self) -> None: registry_filters.sources = [models.ClinicalTrialSource.CLINICALTRIALS_GOV] # Limit the clinical trial to a certain location, in this case California, USA registry_filters.facility_locations = [ - models.GeographicLocation(country_or_region="United States", city="Gilbert", state="Arizona")] + models.GeographicLocation(country_or_region="United States", city="Gilbert", state="Arizona") + ] # Limit the trial to a specific study type, interventional registry_filters.study_types = [models.ClinicalTrialStudyType.INTERVENTIONAL] @@ -96,19 +97,21 @@ def print_results(trial_matcher_result): def get_patient_from_fhir_patient(self) -> models.PatientRecord: patient_info = models.PatientInfo(sex=models.PatientInfoSex.MALE, birth_date=datetime.date(1965, 12, 26)) - patient_data = models.PatientDocument(type=models.DocumentType.FHIR_BUNDLE, - id="Consultation-14-Demo", - content=models.DocumentContent( - source_type=models.DocumentContentSourceType.INLINE, - value=self.get_patient_doc_content()), - clinical_type=models.ClinicalDocumentType.CONSULTATION) + patient_data = models.PatientDocument( + type=models.DocumentType.FHIR_BUNDLE, + id="Consultation-14-Demo", + content=models.DocumentContent( + source_type=models.DocumentContentSourceType.INLINE, value=self.get_patient_doc_content() + ), + clinical_type=models.ClinicalDocumentType.CONSULTATION, + ) return models.PatientRecord(id="patient_id", info=patient_info, data=[patient_data]) @staticmethod def get_patient_doc_content() -> str: samples_dir = os.path.dirname(os.path.realpath(__file__)) data_location = os.path.join(samples_dir, "sample_data/match_trial_fhir_data.json") - with open(data_location, 'r', encoding='utf-8-sig') as f: + with open(data_location, "r", encoding="utf-8-sig") as f: content = f.read() return content diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_structured_coded_elements.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_structured_coded_elements.py index 7f7310135d91..ba39ee2b8fc6 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_structured_coded_elements.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/samples/sample_match_trials_structured_coded_elements.py @@ -38,39 +38,39 @@ def match_trials(self): # Create a Trial Matcher client # - trial_matcher_client = ClinicalMatchingClient(endpoint=ENDPOINT, - credential=AzureKeyCredential(KEY)) + trial_matcher_client = ClinicalMatchingClient(endpoint=ENDPOINT, credential=AzureKeyCredential(KEY)) # # Create clinical info list # - clinical_info_list = [models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0032181", - name="Platelet count", - value="250000"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0002965", - name="Unstable Angina", - value="true"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C1522449", - name="Radiotherapy", - value="false"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C0242957", - name="GeneOrProtein-Expression", - value="Negative;EntityType:GENEORPROTEIN-EXPRESSION"), - models.ClinicalCodedElement(system="http://www.nlm.nih.gov/research/umls", - code="C1300072", - name="cancer stage", - value="2")] + clinical_info_list = [ + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C0032181", name="Platelet count", value="250000" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C0002965", name="Unstable Angina", value="true" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C1522449", name="Radiotherapy", value="false" + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", + code="C0242957", + name="GeneOrProtein-Expression", + value="Negative;EntityType:GENEORPROTEIN-EXPRESSION", + ), + models.ClinicalCodedElement( + system="http://www.nlm.nih.gov/research/umls", code="C1300072", name="cancer stage", value="2" + ), + ] # # Construct Patient # - patient_info = models.PatientInfo(sex=models.PatientInfoSex.MALE, birth_date=datetime.date(1965, 12, 26), - clinical_info=clinical_info_list) + patient_info = models.PatientInfo( + sex=models.PatientInfoSex.MALE, birth_date=datetime.date(1965, 12, 26), clinical_info=clinical_info_list + ) patient1 = models.PatientRecord(id="patient_id", info=patient_info) # @@ -82,7 +82,8 @@ def match_trials(self): registry_filters.sources = [models.ClinicalTrialSource.CLINICALTRIALS_GOV] # Limit the clinical trial to a certain location, in this case California, USA registry_filters.facility_locations = [ - models.GeographicLocation(country_or_region="United States", city="Gilbert", state="Arizona")] + models.GeographicLocation(country_or_region="United States", city="Gilbert", state="Arizona") + ] # Limit the trial to a specific recruitment status registry_filters.recruitment_statuses = [models.ClinicalTrialRecruitmentStatus.RECRUITING] diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/setup.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/setup.py index dcd818c0a978..e6f19c062c9e 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/setup.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/setup.py @@ -13,7 +13,7 @@ PACKAGE_NAME = "azure-healthinsights-clinicalmatching" -PACKAGE_PPRINT_NAME = "Cognitive Services Health Insights Clinical Matching" +PACKAGE_PPRINT_NAME = "Azure Health Insights - Clinical Matching" # a-b-c => a/b/c package_folder_path = PACKAGE_NAME.replace("-", "/") @@ -29,7 +29,7 @@ setup( name=PACKAGE_NAME, version=version, - description='Microsoft {} Client Library for Python'.format(PACKAGE_PPRINT_NAME), + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), long_description=open("README.md", "r").read(), long_description_content_type="text/markdown", license="MIT License", @@ -42,11 +42,11 @@ "Programming Language :: Python", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "License :: OSI Approved :: MIT License", ], zip_safe=False, @@ -60,12 +60,12 @@ ), include_package_data=True, package_data={ - "pytyped": ["py.typed"], + "azure.healthinsights.clinicalmatching": ["py.typed"], }, install_requires=[ "isodate<1.0.0,>=0.6.1", - "azure-core<2.0.0,>=1.24.0", - "typing-extensions>=4.3.0; python_version<'3.8.0'", + "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", ], - python_requires=">=3.7", + python_requires=">=3.8", ) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/conftest.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/conftest.py index ce09206dd299..1c59fd964e90 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/conftest.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/conftest.py @@ -47,6 +47,4 @@ def add_sanitizers(test_proxy): add_general_regex_sanitizer( regex=healthinsights_endpoint, value="https://fake_ad_resource.cognitiveservices.azure.com/" ) - add_general_regex_sanitizer( - regex=healthinsights_key, value="00000000000000000000000000000000" - ) + add_general_regex_sanitizer(regex=healthinsights_key, value="00000000000000000000000000000000") diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/test_match_trials.py b/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/test_match_trials.py index 24da4826c1d3..df03caea92a2 100644 --- a/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/test_match_trials.py +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/tests/test_match_trials.py @@ -19,12 +19,12 @@ class TestMatchTrials(AzureRecordedTestCase): - @HealthInsightsEnvPreparer() @recorded_by_proxy def test_match_trials(self, healthinsights_endpoint, healthinsights_key): - clinical_matching_client = ClinicalMatchingClient(healthinsights_endpoint, - AzureKeyCredential(healthinsights_key)) + clinical_matching_client = ClinicalMatchingClient( + healthinsights_endpoint, AzureKeyCredential(healthinsights_key) + ) assert clinical_matching_client is not None @@ -33,26 +33,16 @@ def test_match_trials(self, healthinsights_endpoint, healthinsights_key): "clinicalTrials": { "registryFilters": [ { - "conditions": [ - "non small cell lung cancer (nsclc)" - ], - "sources": [ - "clinicaltrials_gov" - ], - "recruitmentStatuses": [ - "recruiting" - ], + "conditions": ["non small cell lung cancer (nsclc)"], + "sources": ["clinicaltrials_gov"], + "recruitmentStatuses": ["recruiting"], "facilityLocations": [ - { - "city": "gilbert", - "state": "arizona", - "countryOrRegion": "United States" - } - ] + {"city": "gilbert", "state": "arizona", "countryOrRegion": "United States"} + ], } ] }, - "includeEvidence": True + "includeEvidence": True, }, "patients": [ { @@ -60,39 +50,41 @@ def test_match_trials(self, healthinsights_endpoint, healthinsights_key): "info": { "sex": "male", "birthDate": "1961-04-25T09:54:29.5210127+00:00", - "clinicalInfo": [{ - "system": "http://www.nlm.nih.gov/research/umls", - "code": "C0032181", - "name": "Platelet count", - "value": "250000" - }, + "clinicalInfo": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0032181", + "name": "Platelet count", + "value": "250000", + }, { "system": "http://www.nlm.nih.gov/research/umls", "code": "C0002965", "name": "Unstable Angina", - "value": "true" + "value": "true", }, { "system": "http://www.nlm.nih.gov/research/umls", "code": "C1522449", "name": "Radiotherapy", - "value": "false" + "value": "false", }, { "system": "http://www.nlm.nih.gov/research/umls", "code": "C0242957", "name": "GeneOrProtein-Expression", - "value": "Negative;EntityType:GENEORPROTEIN-EXPRESSION" + "value": "Negative;EntityType:GENEORPROTEIN-EXPRESSION", }, { "system": "http://www.nlm.nih.gov/research/umls", "code": "C1300072", "name": "cancer stage", - "value": "2" - }] - } + "value": "2", + }, + ], + }, } - ] + ], } poller = clinical_matching_client.begin_match_trials(data) diff --git a/sdk/healthinsights/azure-healthinsights-clinicalmatching/tsp-location.yaml b/sdk/healthinsights/azure-healthinsights-clinicalmatching/tsp-location.yaml new file mode 100644 index 000000000000..67c3dd487689 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-clinicalmatching/tsp-location.yaml @@ -0,0 +1,7 @@ +additionalDirectories: +- specification/ai/HealthInsights/HealthInsights.Common/ +- specification/ai/HealthInsights/HealthInsights.OpenAPI/ +directory: specification/ai/HealthInsights/HealthInsights.TrialMatcher +commit: 70a4ccdd2be61ae5bc524250c70270b0f4f2b540 +repo: Azure/azure-rest-api-specs + diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/CHANGELOG.md b/sdk/healthinsights/azure-healthinsights-patienttimeline/CHANGELOG.md new file mode 100644 index 000000000000..628743d283a9 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/CHANGELOG.md @@ -0,0 +1,5 @@ +# Release History + +## 1.0.0b1 (1970-01-01) + +- Initial version diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/LICENSE b/sdk/healthinsights/azure-healthinsights-patienttimeline/LICENSE new file mode 100644 index 000000000000..63447fd8bbbf --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/MANIFEST.in b/sdk/healthinsights/azure-healthinsights-patienttimeline/MANIFEST.in new file mode 100644 index 000000000000..2b5f05d0f32a --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/MANIFEST.in @@ -0,0 +1,7 @@ +include *.md +include LICENSE +include azure/healthinsights/patienttimeline/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/healthinsights/__init__.py \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/README.md b/sdk/healthinsights/azure-healthinsights-patienttimeline/README.md new file mode 100644 index 000000000000..2c24bc74d1fc --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/README.md @@ -0,0 +1,45 @@ + + +# Azure Health Insights - Patient Timeline client library for Python + + +## Getting started + +### Installating the package + +```bash +python -m pip install azure-healthinsights-patienttimeline +``` + +#### Prequisites + +- Python 3.8 or later is required to use this package. +- You need an [Azure subscription][azure_sub] to use this package. +- An existing Azure Health Insights - Patient Timeline instance. + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials +[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential +[pip]: https://pypi.org/project/pip/ +[azure_sub]: https://azure.microsoft.com/free/ + diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/_meta.json b/sdk/healthinsights/azure-healthinsights-patienttimeline/_meta.json new file mode 100644 index 000000000000..dc402291085c --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "70a4ccdd2be61ae5bc524250c70270b0f4f2b540", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/ai/HealthInsights/HealthInsights.PatientTimeline", + "@azure-tools/typespec-python": "0.21.0" +} \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/__init__.py new file mode 100644 index 000000000000..61f886258bf5 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/__init__.py @@ -0,0 +1,26 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import PatientTimelineClient +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "PatientTimelineClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_client.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_client.py new file mode 100644 index 000000000000..94be4720ff56 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_client.py @@ -0,0 +1,98 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any + +from azure.core import PipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import PatientTimelineClientConfiguration +from ._operations import PatientTimelineClientOperationsMixin +from ._serialization import Deserializer, Serializer + + +class PatientTimelineClient(PatientTimelineClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + """PatientTimelineClient. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + _endpoint = "{endpoint}/health-insights" + self._config = PatientTimelineClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> "PatientTimelineClient": + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_configuration.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_configuration.py new file mode 100644 index 000000000000..b091892ebf72 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_configuration.py @@ -0,0 +1,62 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from ._version import VERSION + + +class PatientTimelineClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for PatientTimelineClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + kwargs.setdefault("sdk_moniker", "healthinsights-patienttimeline/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AzureKeyCredentialPolicy( + self.credential, "Ocp-Apim-Subscription-Key", **kwargs + ) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_model_base.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_model_base.py new file mode 100644 index 000000000000..1ddc071517d6 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_model_base.py @@ -0,0 +1,874 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except + +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import copy +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] # pylint: disable=protected-access + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): # pylint: disable=unsubscriptable-object + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = copy.deepcopy(data) + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: + ... + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: + ... + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + return self._data.popitem() + + def clear(self) -> None: + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: + ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: + ... + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument + # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' + mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") # pylint: disable=no-member + for k, v in mro_class.__annotations__.items() # pylint: disable=no-member + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) + + return super().__new__(cls) # pylint: disable=no-value-for-parameter + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): # pylint: disable=no-member + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: + for v in cls.__dict__.values(): + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access + return v._rest_name # pylint: disable=protected-access + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): # pylint: disable=no-member + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member + if mapped_cls == cls: + return cls(data) + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation or annotation in [int, float]: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + except AttributeError: + pass + + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) + + try: + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + obj: typing.Dict[typing.Any, typing.Any], + ): + if obj is None: + return obj + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + return functools.partial( + _deserialize_dict, + value_deserializer, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore + + def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, + ): + if obj is None: + return obj + return type(obj)( + _deserialize(deserializer, entry, module) + for entry, deserializer in zip(obj, entry_deserializers) + ) + + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + obj, + ): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + return functools.partial(_deserialize_sequence, deserializer) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): + try: + if value is None or isinstance(value, _Null): + return None + if deserializer is None: + return value + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/__init__.py new file mode 100644 index 000000000000..c06198998973 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/__init__.py @@ -0,0 +1,19 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import PatientTimelineClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "PatientTimelineClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_operations.py new file mode 100644 index 000000000000..758bc95b7a08 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_operations.py @@ -0,0 +1,3050 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import datetime +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload +import uuid + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.polling import LROPoller, NoPolling, PollingMethod +from azure.core.polling.base_polling import LROBasePolling +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._model_base import SdkJSONEncoder, _deserialize +from .._serialization import Serializer +from .._vendor import PatientTimelineClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_patient_timeline_infer_patient_timeline_request( # pylint: disable=name-too-long + **kwargs: Any, +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/patient-timeline/jobs" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if "Repeatability-Request-ID" not in _headers: + _headers["Repeatability-Request-ID"] = str(uuid.uuid4()) + if "Repeatability-First-Sent" not in _headers: + _headers["Repeatability-First-Sent"] = _SERIALIZER.serialize_data( + datetime.datetime.now(datetime.timezone.utc), "rfc-1123" + ) + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +class PatientTimelineClientOperationsMixin(PatientTimelineClientMixinABC): + def _infer_patient_timeline_initial( + self, body: Union[_models.PatientTimelineData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[JSON] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_patient_timeline_infer_patient_timeline_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(JSON, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_infer_patient_timeline( + self, body: _models.PatientTimelineData, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Required. + :type body: ~azure.healthinsights.patienttimeline.models.PatientTimelineData + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + + @overload + def begin_infer_patient_timeline( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + + @overload + def begin_infer_patient_timeline( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + + @distributed_trace + def begin_infer_patient_timeline( + self, body: Union[_models.PatientTimelineData, JSON, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Is one of the following types: PatientTimelineData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.patienttimeline.models.PatientTimelineData or JSON or + IO[bytes] + :return: An instance of LROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.PatientTimelineInferenceResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._infer_patient_timeline_initial( + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response_headers = {} + response = pipeline_response.http_response + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.PatientTimelineInferenceResult, response.json().get("result")) + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + return deserialized + + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method: PollingMethod = cast( + PollingMethod, LROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs) + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.PatientTimelineInferenceResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.PatientTimelineInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_patch.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_patch.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_serialization.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_serialization.py new file mode 100644 index 000000000000..2f781d740827 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_serialization.py @@ -0,0 +1,1998 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the ""Software""), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + TypeVar, + MutableMapping, + Type, + List, + Mapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +ModelType = TypeVar("ModelType", bound="Model") +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + + +try: + from datetime import timezone as _FixedOffset # type: ignore +except ImportError: # Python 2.7 + + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds() / 3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node.""" + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls: Type[ModelType], + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> ModelType: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result.update(objects[valuetype]._flatten_subtype(key, objects)) + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + Remove the polymorphic key from the initial data. + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + """ + return key.replace("\\.", ".") + + +class Serializer(object): + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises: SerializationError if serialization fails. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized.update(target_obj.additional_properties) + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises: SerializationError if serialization fails. + :raises: ValueError if data is None + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + elif data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, data.__class__) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param data: Object to be serialized. + :rtype: str + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + else: + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. + :rtype: list, str + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + elif obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises: SerializationError if format invalid + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError: + raise TypeError("Unix time object must be valid Datetime object.") + + +def rest_key_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(List[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key.""" + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + else: + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + else: # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer(object): + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + elif isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None: + return data + try: + attributes = response._attribute_map # type: ignore + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + else: + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param raw_data: Data to be processed. + :param content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param response: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [k for k, v in response._validation.items() if v.get("readonly")] + const = [k for k, v in response._validation.items() if v.get("constant")] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) + + def deserialize_data(self, data, data_type): + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + else: + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :rtype: dict + :raises: TypeError if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :rtype: str, int, float or bool + :raises: TypeError if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + else: + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + elif isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + elif attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + else: + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :rtype: long or int + :raises: ValueError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :rtype: TimeDelta + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :rtype: Date + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :rtype: Datetime + :raises: DeserializationError if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + else: + return date_obj diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_vendor.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_vendor.py new file mode 100644 index 000000000000..26be159a3700 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_vendor.py @@ -0,0 +1,26 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import PatientTimelineClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import PipelineClient + + from ._serialization import Deserializer, Serializer + + +class PatientTimelineClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "PipelineClient" + _config: PatientTimelineClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_version.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_version.py new file mode 100644 index 000000000000..be71c81bd282 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/__init__.py new file mode 100644 index 000000000000..95f6482fc154 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/__init__.py @@ -0,0 +1,23 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import PatientTimelineClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "PatientTimelineClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_client.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_client.py new file mode 100644 index 000000000000..ea019fd30fcd --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_client.py @@ -0,0 +1,100 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable + +from azure.core import AsyncPipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._serialization import Deserializer, Serializer +from ._configuration import PatientTimelineClientConfiguration +from ._operations import PatientTimelineClientOperationsMixin + + +class PatientTimelineClient(PatientTimelineClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + """PatientTimelineClient. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + _endpoint = "{endpoint}/health-insights" + self._config = PatientTimelineClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> "PatientTimelineClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_configuration.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_configuration.py new file mode 100644 index 000000000000..1ceb33b73ff5 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_configuration.py @@ -0,0 +1,62 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from .._version import VERSION + + +class PatientTimelineClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for PatientTimelineClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + kwargs.setdefault("sdk_moniker", "healthinsights-patienttimeline/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AzureKeyCredentialPolicy( + self.credential, "Ocp-Apim-Subscription-Key", **kwargs + ) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/__init__.py new file mode 100644 index 000000000000..c06198998973 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/__init__.py @@ -0,0 +1,19 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import PatientTimelineClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "PatientTimelineClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_operations.py new file mode 100644 index 000000000000..5672cb1642cf --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_operations.py @@ -0,0 +1,3016 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod +from azure.core.polling.async_base_polling import AsyncLROBasePolling +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._model_base import SdkJSONEncoder, _deserialize +from ..._operations._operations import build_patient_timeline_infer_patient_timeline_request +from .._vendor import PatientTimelineClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class PatientTimelineClientOperationsMixin(PatientTimelineClientMixinABC): + async def _infer_patient_timeline_initial( + self, body: Union[_models.PatientTimelineData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[JSON] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_patient_timeline_infer_patient_timeline_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(JSON, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_infer_patient_timeline( + self, body: _models.PatientTimelineData, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Required. + :type body: ~azure.healthinsights.patienttimeline.models.PatientTimelineData + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + + @overload + async def begin_infer_patient_timeline( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + + @overload + async def begin_infer_patient_timeline( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + + @distributed_trace_async + async def begin_infer_patient_timeline( + self, body: Union[_models.PatientTimelineData, JSON, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.PatientTimelineInferenceResult]: + # pylint: disable=line-too-long + """Create Patient Timeline job. + + Creates a Patient Timeline job with the given request body. + + :param body: Is one of the following types: PatientTimelineData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.patienttimeline.models.PatientTimelineData or JSON or + IO[bytes] + :return: An instance of AsyncLROPoller that returns PatientTimelineInferenceResult. The + PatientTimelineInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + { + "type": "str", # The type of the Patient + Timeline inference. Required. Known values are: "timelineEvent" + and "summaryItem". + "extension": [ + { + "url": "str", # Source of + the definition for the extension code - a logical name or + a URL. Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. Symbol in syntax + defined by the system. + "display": "str", # Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": + "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of the + terminology system. + "version": "str" # Optional. Version of the + system - if relevant. + } + ], + "text": "str" # + Optional. Plain text representation of the concept. + }, + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # + Optional. Value as integer. + "valuePeriod": { + "end": "str", # + Optional. End time with inclusive boundary, if not + ongoing. + "start": "str" # + Optional. Starting time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # + Optional. Coded form of the unit. + "comparator": "str", + # Optional. < | <= | >= | > - how to understand the + value. + "system": "str", # + Optional. System that defines coded unit form. + "unit": "str", # + Optional. Unit representation. + "value": 0.0 # + Optional. Numerical value (with implicit precision). + }, + "valueRange": { + "high": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "low": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "numerator": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative for the resource. + "identifier": { + "assigner": + ..., + "period": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "system": + "str", # Optional. The namespace for the + identifier value. + "type": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique id + for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology system. + "version": "str" # Optional. Version + of the system - if relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "use": "str", + # Optional. usual | official | temp | secondary | + old (If known). + "value": + "str" # Optional. The value that is unique. + }, + "reference": "str", + # Optional. Literal reference, Relative, internal or + absolute URL. + "type": "str" # + Optional. Type the reference refers to (e.g. + "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # + Number of sample points at each time point. Required. + "origin": { + "code": + "str", # Optional. Coded form of the unit. + "comparator": + "str", # Optional. < | <= | >= | > - how to + understand the value. + "system": + "str", # Optional. System that defines coded + unit form. + "unit": + "str", # Optional. Unit representation. + "value": 0.0 + # Optional. Numerical value (with implicit + precision). + }, + "period": 0.0, # + Number of milliseconds between samples. Required. + "data": "str", # + Optional. Decimal values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # + Optional. Multiply data by this before adding to + origin. + "lowerLimit": 0.0, # + Optional. Lower limit of detection. + "upperLimit": 0.0 # + Optional. Upper limit of detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time (hh:mm:ss). + } + ], + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + }, + "resource": domain_resource + } + ], + "patientId": "str" # The identifier given for the patient in + the request. Required. + } + ] + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.PatientTimelineInferenceResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._infer_patient_timeline_initial( + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response_headers = {} + response = pipeline_response.http_response + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.PatientTimelineInferenceResult, response.json().get("result")) + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + return deserialized + + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method: AsyncPollingMethod = cast( + AsyncPollingMethod, + AsyncLROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs), + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.PatientTimelineInferenceResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.PatientTimelineInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_patch.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_patch.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_vendor.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_vendor.py new file mode 100644 index 000000000000..ee9a06dc14af --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/aio/_vendor.py @@ -0,0 +1,26 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import PatientTimelineClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import AsyncPipelineClient + + from .._serialization import Deserializer, Serializer + + +class PatientTimelineClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "AsyncPipelineClient" + _config: PatientTimelineClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/__init__.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/__init__.py new file mode 100644 index 000000000000..024a8056d59b --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/__init__.py @@ -0,0 +1,129 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import Annotation +from ._models import CodeableConcept +from ._models import Coding +from ._models import Condition +from ._models import ConditionStage +from ._models import ContactDetail +from ._models import ContactPoint +from ._models import DocumentAdministrativeMetadata +from ._models import DocumentAuthor +from ._models import DocumentContent +from ._models import DomainResource +from ._models import Element +from ._models import Encounter +from ._models import Error +from ._models import Extension +from ._models import HealthInsightsOperationStatus +from ._models import Identifier +from ._models import InnerError +from ._models import Meta +from ._models import Narrative +from ._models import Observation +from ._models import ObservationComponent +from ._models import ObservationReferenceRange +from ._models import OrderedProcedure +from ._models import PatientDetails +from ._models import PatientDocument +from ._models import PatientRecord +from ._models import PatientTimelineData +from ._models import PatientTimelineInference +from ._models import PatientTimelineInferenceResult +from ._models import PatientTimelineModelConfiguration +from ._models import PatientTimelinePatientResult +from ._models import Period +from ._models import Quantity +from ._models import Range +from ._models import Ratio +from ._models import Reference +from ._models import ResearchStudy +from ._models import ResearchStudyArm +from ._models import ResearchStudyObjective +from ._models import Resource +from ._models import SampledData +from ._models import TimePeriod + +from ._enums import ClinicalDocumentType +from ._enums import ContactPointSystem +from ._enums import ContactPointUse +from ._enums import DocumentContentSourceType +from ._enums import DocumentType +from ._enums import EncounterClass +from ._enums import JobStatus +from ._enums import ObservationStatusCodeType +from ._enums import PatientSex +from ._enums import PatientTimelineInferenceType +from ._enums import RepeatabilityResult +from ._enums import ResearchStudyStatusCodeType +from ._enums import SpecialtyType +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "Annotation", + "CodeableConcept", + "Coding", + "Condition", + "ConditionStage", + "ContactDetail", + "ContactPoint", + "DocumentAdministrativeMetadata", + "DocumentAuthor", + "DocumentContent", + "DomainResource", + "Element", + "Encounter", + "Error", + "Extension", + "HealthInsightsOperationStatus", + "Identifier", + "InnerError", + "Meta", + "Narrative", + "Observation", + "ObservationComponent", + "ObservationReferenceRange", + "OrderedProcedure", + "PatientDetails", + "PatientDocument", + "PatientRecord", + "PatientTimelineData", + "PatientTimelineInference", + "PatientTimelineInferenceResult", + "PatientTimelineModelConfiguration", + "PatientTimelinePatientResult", + "Period", + "Quantity", + "Range", + "Ratio", + "Reference", + "ResearchStudy", + "ResearchStudyArm", + "ResearchStudyObjective", + "Resource", + "SampledData", + "TimePeriod", + "ClinicalDocumentType", + "ContactPointSystem", + "ContactPointUse", + "DocumentContentSourceType", + "DocumentType", + "EncounterClass", + "JobStatus", + "ObservationStatusCodeType", + "PatientSex", + "PatientTimelineInferenceType", + "RepeatabilityResult", + "ResearchStudyStatusCodeType", + "SpecialtyType", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_enums.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_enums.py new file mode 100644 index 000000000000..37c593669505 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_enums.py @@ -0,0 +1,223 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class ClinicalDocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the clinical document.""" + + CONSULTATION = "consultation" + DISCHARGE_SUMMARY = "dischargeSummary" + HISTORY_AND_PHYSICAL = "historyAndPhysical" + RADIOLOGY_REPORT = "radiologyReport" + PROCEDURE = "procedure" + PROGRESS = "progress" + LABORATORY = "laboratory" + PATHOLOGY_REPORT = "pathologyReport" + + +class ContactPointSystem(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Contact Point System + see https://www.hl7.org/fhir/R4/valueset-contact-point-system.html. + """ + + PHONE = "phone" + """Phone""" + FAX = "fax" + """Fax""" + EMAIL = "email" + """Email""" + PAGER = "pager" + """Pager""" + URL = "url" + """Url""" + SMS = "sms" + """Sms""" + OTHER = "other" + """Other""" + + +class ContactPointUse(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Contact Point Use + See: http://hl7.org/fhir/ValueSet/contact-point-use. + """ + + HOME = "home" + """Home""" + WORK = "work" + """Work""" + TEMP = "temp" + """Temp""" + OLD = "old" + """Old""" + MOBILE = "mobile" + """Mobile""" + + +class DocumentContentSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. + """ + + INLINE = "inline" + """The content is given as a string (for instance, text).""" + REFERENCE = "reference" + """The content is given as a URI.""" + + +class DocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON + document). + """ + + NOTE = "note" + FHIR_BUNDLE = "fhirBundle" + DICOM = "dicom" + GENOMIC_SEQUENCING = "genomicSequencing" + + +class EncounterClass(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR + value set--http://....). + """ + + IN_PATIENT = "inpatient" + """A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned + to a location where patients generally stay at least overnight and provided with room, board, + and continuous nursing service.""" + AMBULATORY = "ambulatory" + """The term ambulatory usually implies that the patient has come to the location and is not + assigned to a bed. Sometimes referred to as an outpatient encounter.""" + OBSERVATION = "observation" + """An encounter where the patient usually will start in different encounter, such as one in the + emergency department but then transition to this type of encounter because they require a + significant period of treatment and monitoring to determine whether or not their condition + warrants an inpatient admission or discharge.""" + EMERGENCY = "emergency" + """A patient encounter that takes place at a dedicated healthcare service delivery location where + the patient receives immediate evaluation and treatment, provided until the patient can be + discharged or responsibility for the patient's care is transferred elsewhere (for example, the + patient could be admitted as an inpatient or transferred to another facility.""" + VIRTUAL = "virtual" + """A patient encounter where the patient is not physically present for the encounter, such as in a + telehealth encounter, phone call, or electronic communication.""" + HEALTH_HOME = "healthHome" + """Healthcare encounter that takes place in the residence of the patient or a designee""" + + +class JobStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The status of the processing job.""" + + NOT_STARTED = "notStarted" + RUNNING = "running" + SUCCEEDED = "succeeded" + FAILED = "failed" + CANCELED = "canceled" + + +class ObservationStatusCodeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Observation Status + Based on `FHIR ObservationStatus + `_. + """ + + REGISTERED = "registered" + """The existence of the observation is registered, but there is no result yet available.""" + PRELIMINARY = "preliminary" + """This is an initial or interim observation: data may be incomplete or unverified.""" + FINAL = "final" + """The observation is complete and verified by an authorized person.""" + AMENDED = "amended" + """Subsequent to being Final, the observation has been modified subsequent. This includes + updates/new information and corrections.""" + CORRECTED = "corrected" + """Subsequent to being Final, the observation has been modified to correct an error in the test + result.""" + CANCELLED = "cancelled" + """The observation is unavailable because the measurement was not started or not completed (also + sometimes called "aborted").""" + ENTERED_IN_ERROR = "entered-in-error" + """The observation has been withdrawn following previous final release.""" + UNKNOWN = "unknown" + """The observation status is unknown. Note that "unknown" is a value of last resort and every + attempt should be made to provide a meaningful value other than "unknown".""" + + +class PatientSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The patient's sex.""" + + FEMALE = "female" + MALE = "male" + UNSPECIFIED = "unspecified" + + +class PatientTimelineInferenceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the Patient Timeline inference.""" + + TIMELINE_EVENT = "timelineEvent" + """The inference is a timeline event.""" + SUMMARY_ITEM = "summaryItem" + """The inference is a summary item.""" + + +class RepeatabilityResult(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Repeatability Result header options.""" + + ACCEPTED = "accepted" + """If the request was accepted and the server guarantees that the server state reflects a single + execution of the operation.""" + REJECTED = "rejected" + """If the request was rejected because the combination of Repeatability-First-Sent and + Repeatability-Request-ID were invalid + or because the Repeatability-First-Sent value was outside the range of values held by the + server.""" + + +class ResearchStudyStatusCodeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """https://www.hl7.org/fhir/R4/codesystem-research-study-status.html.""" + + ACTIVE = "active" + """The study is open for accrual.""" + ADMINISTRATIVELY_COMPLETED = "administratively-completed" + """Study is completed prematurely and will not resume; patients are no longer examined nor + treated.""" + APPROVED = "approved" + """Protocol is approved by the review board.""" + CLOSED_TO_ACCRUAL = "closed-to-accrual" + """Study is closed for accrual; patients can be examined and treated.""" + CLOSED_TO_ACCRUAL_AND_INTERVENTION = "closed-to-accrual-and-intervention" + """The study is closed to accrual and intervention, i.e. the study is closed to enrollment, all + study subjects have completed treatment or intervention but are still being followed according + to the primary objective of the study.""" + COMPLETED = "completed" + """Study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study + subjects have completed treatment or intervention but are still being followed according to the + primary objective of the study.""" + DISAPPROVED = "disapproved" + """Protocol was disapproved by the review board.""" + IN_REVIEW = "in-review" + """Protocol is submitted to the review board for approval.""" + TEMPORARILY_CLOSED_TO_ACCRUAL = "temporarily-closed-to-accrual" + """The study is temporarily closed to accrual; a pause in accrual while study is reviewed, but is + expected to resume.""" + TEMPORARILY_CLOSED_TO_ACCRUAL_AND_INTERVENTION = "temporarily-closed-to-accrual-and-intervention" + """Study is temporarily closed for accrual; can be potentially resumed in the future""" + WITHDRAWN = "withdrawn" + """Protocol was withdrawn by the lead organization.""" + + +class SpecialtyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the type of the Specialty.""" + + PATHOLOGY = "pathology" + """pathology""" + RADIOLOGY = "radiology" + """radiology""" diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_models.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_models.py new file mode 100644 index 000000000000..ae3952095e4c --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_models.py @@ -0,0 +1,2538 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +import datetime +from typing import Any, Dict, List, Literal, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .. import _model_base +from .._model_base import rest_discriminator, rest_field + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from .. import models as _models + + +class Element(_model_base.Model): + """The base definition for all elements contained inside a resource. + Based on `FHIR Element `_. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + """ + + id: Optional[str] = rest_field() + """Unique id for inter-element referencing.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Annotation(Element): + """A text note which also contains information about who made the statement and when + Based on `FHIR Annotation `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar author_string: Individual responsible for the annotation. + :vartype author_string: str + :ivar time: When the annotation was made. + :vartype time: str + :ivar text: The annotation - text content (as markdown). Required. + :vartype text: str + """ + + author_string: Optional[str] = rest_field(name="authorString") + """Individual responsible for the annotation.""" + time: Optional[str] = rest_field() + """When the annotation was made.""" + text: str = rest_field() + """The annotation - text content (as markdown). Required.""" + + @overload + def __init__( + self, + *, + text: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + author_string: Optional[str] = None, + time: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CodeableConcept(Element): + """Concept - reference to a terminology or just text + Based on `FHIR CodeableConcept `_. + + :ivar coding: Code defined by a terminology system. + :vartype coding: list[~azure.healthinsights.patienttimeline.models.Coding] + :ivar text: Plain text representation of the concept. + :vartype text: str + """ + + coding: Optional[List["_models.Coding"]] = rest_field() + """Code defined by a terminology system.""" + text: Optional[str] = rest_field() + """Plain text representation of the concept.""" + + @overload + def __init__( + self, + *, + coding: Optional[List["_models.Coding"]] = None, + text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Coding(Element): + """A Coding is a representation of a defined concept using a symbol from a defined "code system". + Based on `FHIR Coding `_. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar system: Identity of the terminology system. + :vartype system: str + :ivar version: Version of the system - if relevant. + :vartype version: str + :ivar code: Symbol in syntax defined by the system. + :vartype code: str + :ivar display: Representation defined by the system. + :vartype display: str + """ + + system: Optional[str] = rest_field() + """Identity of the terminology system.""" + version: Optional[str] = rest_field() + """Version of the system - if relevant.""" + code: Optional[str] = rest_field() + """Symbol in syntax defined by the system.""" + display: Optional[str] = rest_field() + """Representation defined by the system.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + system: Optional[str] = None, + version: Optional[str] = None, + code: Optional[str] = None, + display: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Resource(_model_base.Model): + """Resource is the ancestor of DomainResource from which most resources are derived. Bundle, + Parameters, and Binary extend Resource directly. + Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html. + + All required parameters must be populated in order to send to server. + + :ivar resource_type: The type of resource. Required. + :vartype resource_type: str + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.patienttimeline.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + """ + + resource_type: str = rest_field(name="resourceType") + """The type of resource. Required.""" + id: Optional[str] = rest_field() + """Resource Id.""" + meta: Optional["_models.Meta"] = rest_field() + """Metadata about the resource.""" + implicit_rules: Optional[str] = rest_field(name="implicitRules") + """A set of rules under which this content was created.""" + language: Optional[str] = rest_field() + """Language of the resource content.""" + + @overload + def __init__( + self, + *, + resource_type: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DomainResource(Resource): + """A resource with narrative, extensions, and contained resources + Based on `FHIR DomainResource `_. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + Condition, Observation, ResearchStudy + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.patienttimeline.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.patienttimeline.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.patienttimeline.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar resource_type: Required. Default value is None. + :vartype resource_type: str + """ + + __mapping__: Dict[str, _model_base.Model] = {} + text: Optional["_models.Narrative"] = rest_field() + """Text summary of the resource, for human interpretation.""" + contained: Optional[List["_models.Resource"]] = rest_field() + """Contained, inline Resources.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + modifier_extension: Optional[List["_models.Extension"]] = rest_field(name="modifierExtension") + """Extensions that cannot be ignored.""" + resource_type: str = rest_discriminator(name="resourceType") + """Required. Default value is None.""" + + @overload + def __init__( + self, + *, + resource_type: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Condition(DomainResource, discriminator="Condition"): # pylint: disable=too-many-instance-attributes + """Detailed information about conditions, problems or diagnoses + Based on `FHIR Condition `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.patienttimeline.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.patienttimeline.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.patienttimeline.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "Condition". + :vartype resource_type: str + :ivar identifier: External Ids for this condition. + :vartype identifier: list[~azure.healthinsights.patienttimeline.models.Identifier] + :ivar clinical_status: active | recurrence | relapse | inactive | remission | resolved. + :vartype clinical_status: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar verification_status: unconfirmed | provisional | differential | confirmed | refuted | + entered-in-error. + :vartype verification_status: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar category: problem-list-item | encounter-diagnosis. + :vartype category: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar severity: Subjective severity of condition. + :vartype severity: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar code: Identification of the condition, problem or diagnosis. + :vartype code: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar body_site: Anatomical location, if relevant. + :vartype body_site: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar encounter: Encounter created as part of. + :vartype encounter: ~azure.healthinsights.patienttimeline.models.Reference + :ivar onset_date_time: Estimated or actual date, date-time, or age. + :vartype onset_date_time: str + :ivar onset_age: Estimated or actual date, date-time, or age. + :vartype onset_age: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar onset_period: Estimated or actual date, date-time, or age. + :vartype onset_period: ~azure.healthinsights.patienttimeline.models.Period + :ivar onset_range: Estimated or actual date, date-time, or age. + :vartype onset_range: ~azure.healthinsights.patienttimeline.models.Range + :ivar onset_string: Estimated or actual date, date-time, or age. + :vartype onset_string: str + :ivar abatement_date_time: When in resolution/remission. + :vartype abatement_date_time: str + :ivar abatement_age: When in resolution/remission. + :vartype abatement_age: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar abatement_period: When in resolution/remission. + :vartype abatement_period: ~azure.healthinsights.patienttimeline.models.Period + :ivar abatement_range: When in resolution/remission. + :vartype abatement_range: ~azure.healthinsights.patienttimeline.models.Range + :ivar abatement_string: When in resolution/remission. + :vartype abatement_string: str + :ivar recorded_date: Date record was first recorded. + :vartype recorded_date: str + :ivar stage: stge/grade, usually assessed formally. + :vartype stage: list[~azure.healthinsights.patienttimeline.models.ConditionStage] + :ivar note: Additional information about the Condition. + :vartype note: list[~azure.healthinsights.patienttimeline.models.Annotation] + """ + + resource_type: Literal["Condition"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"Condition\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """External Ids for this condition.""" + clinical_status: Optional["_models.CodeableConcept"] = rest_field(name="clinicalStatus") + """active | recurrence | relapse | inactive | remission | resolved.""" + verification_status: Optional["_models.CodeableConcept"] = rest_field(name="verificationStatus") + """unconfirmed | provisional | differential | confirmed | refuted | entered-in-error.""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """problem-list-item | encounter-diagnosis.""" + severity: Optional["_models.CodeableConcept"] = rest_field() + """Subjective severity of condition.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Identification of the condition, problem or diagnosis.""" + body_site: Optional[List["_models.CodeableConcept"]] = rest_field(name="bodySite") + """Anatomical location, if relevant.""" + encounter: Optional["_models.Reference"] = rest_field() + """Encounter created as part of.""" + onset_date_time: Optional[str] = rest_field(name="onsetDateTime") + """Estimated or actual date, date-time, or age.""" + onset_age: Optional["_models.Quantity"] = rest_field(name="onsetAge") + """Estimated or actual date, date-time, or age.""" + onset_period: Optional["_models.Period"] = rest_field(name="onsetPeriod") + """Estimated or actual date, date-time, or age.""" + onset_range: Optional["_models.Range"] = rest_field(name="onsetRange") + """Estimated or actual date, date-time, or age.""" + onset_string: Optional[str] = rest_field(name="onsetString") + """Estimated or actual date, date-time, or age.""" + abatement_date_time: Optional[str] = rest_field(name="abatementDateTime") + """When in resolution/remission.""" + abatement_age: Optional["_models.Quantity"] = rest_field(name="abatementAge") + """When in resolution/remission.""" + abatement_period: Optional["_models.Period"] = rest_field(name="abatementPeriod") + """When in resolution/remission.""" + abatement_range: Optional["_models.Range"] = rest_field(name="abatementRange") + """When in resolution/remission.""" + abatement_string: Optional[str] = rest_field(name="abatementString") + """When in resolution/remission.""" + recorded_date: Optional[str] = rest_field(name="recordedDate") + """Date record was first recorded.""" + stage: Optional[List["_models.ConditionStage"]] = rest_field() + """stge/grade, usually assessed formally.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Additional information about the Condition.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + clinical_status: Optional["_models.CodeableConcept"] = None, + verification_status: Optional["_models.CodeableConcept"] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + severity: Optional["_models.CodeableConcept"] = None, + code: Optional["_models.CodeableConcept"] = None, + body_site: Optional[List["_models.CodeableConcept"]] = None, + encounter: Optional["_models.Reference"] = None, + onset_date_time: Optional[str] = None, + onset_age: Optional["_models.Quantity"] = None, + onset_period: Optional["_models.Period"] = None, + onset_range: Optional["_models.Range"] = None, + onset_string: Optional[str] = None, + abatement_date_time: Optional[str] = None, + abatement_age: Optional["_models.Quantity"] = None, + abatement_period: Optional["_models.Period"] = None, + abatement_range: Optional["_models.Range"] = None, + abatement_string: Optional[str] = None, + recorded_date: Optional[str] = None, + stage: Optional[List["_models.ConditionStage"]] = None, + note: Optional[List["_models.Annotation"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, resource_type="Condition", **kwargs) + + +class ConditionStage(_model_base.Model): + """Stage/grade, usually assessed formally + Based on `FHIR Condition.Stage `_. + + :ivar summary: Simple summary (disease specific). + :vartype summary: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar type: Kind of staging. + :vartype type: ~azure.healthinsights.patienttimeline.models.CodeableConcept + """ + + summary: Optional["_models.CodeableConcept"] = rest_field() + """Simple summary (disease specific).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Kind of staging.""" + + @overload + def __init__( + self, + *, + summary: Optional["_models.CodeableConcept"] = None, + type: Optional["_models.CodeableConcept"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ContactDetail(Element): + """Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail). + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar name: Name of an individual to contact. + :vartype name: str + :ivar telecom: Contact details for individual or organization. + :vartype telecom: list[~azure.healthinsights.patienttimeline.models.ContactPoint] + """ + + name: Optional[str] = rest_field() + """Name of an individual to contact.""" + telecom: Optional[List["_models.ContactPoint"]] = rest_field() + """Contact details for individual or organization.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + name: Optional[str] = None, + telecom: Optional[List["_models.ContactPoint"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ContactPoint(_model_base.Model): + """Details for all kinds of technology mediated contact points for a person or organization, + including telephone, email, etc. + See https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint. + + :ivar system: phone | fax | email | pager | url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and "other". + :vartype system: str or ~azure.healthinsights.patienttimeline.models.ContactPointSystem + :ivar value: The actual contact point details. + :vartype value: str + :ivar use: home | work | temp | old | mobile - purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + :vartype use: str or ~azure.healthinsights.patienttimeline.models.ContactPointUse + :ivar rank: Specify preferred order of use (1 = highest). + :vartype rank: int + :ivar period: Time period when the contact point was/is in use. + :vartype period: ~azure.healthinsights.patienttimeline.models.Period + """ + + system: Optional[Union[str, "_models.ContactPointSystem"]] = rest_field() + """phone | fax | email | pager | url | sms | other. Known values are: \"phone\", \"fax\", + \"email\", \"pager\", \"url\", \"sms\", and \"other\".""" + value: Optional[str] = rest_field() + """The actual contact point details.""" + use: Optional[Union[str, "_models.ContactPointUse"]] = rest_field() + """home | work | temp | old | mobile - purpose of this contact point. Known values are: \"home\", + \"work\", \"temp\", \"old\", and \"mobile\".""" + rank: Optional[int] = rest_field() + """Specify preferred order of use (1 = highest).""" + period: Optional["_models.Period"] = rest_field() + """Time period when the contact point was/is in use.""" + + @overload + def __init__( + self, + *, + system: Optional[Union[str, "_models.ContactPointSystem"]] = None, + value: Optional[str] = None, + use: Optional[Union[str, "_models.ContactPointUse"]] = None, + rank: Optional[int] = None, + period: Optional["_models.Period"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAdministrativeMetadata(_model_base.Model): + """Document administrative metadata. + + :ivar ordered_procedures: List of procedure information associated with the document. + :vartype ordered_procedures: + list[~azure.healthinsights.patienttimeline.models.OrderedProcedure] + :ivar encounter_id: Reference to the encounter associated with the document. + :vartype encounter_id: str + """ + + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = rest_field(name="orderedProcedures") + """List of procedure information associated with the document.""" + encounter_id: Optional[str] = rest_field(name="encounterId") + """Reference to the encounter associated with the document.""" + + @overload + def __init__( + self, + *, + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = None, + encounter_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAuthor(_model_base.Model): + """Document author. + + :ivar id: author id. + :vartype id: str + :ivar full_name: Text representation of the full name. + :vartype full_name: str + """ + + id: Optional[str] = rest_field() + """author id.""" + full_name: Optional[str] = rest_field(name="fullName") + """Text representation of the full name.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + full_name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentContent(_model_base.Model): + """The content of the patient document. + + All required parameters must be populated in order to send to server. + + :ivar source_type: The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: "inline" and "reference". + :vartype source_type: str or + ~azure.healthinsights.patienttimeline.models.DocumentContentSourceType + :ivar value: The content of the document, given either inline (as a string) or as a reference + (URI). Required. + :vartype value: str + """ + + source_type: Union[str, "_models.DocumentContentSourceType"] = rest_field(name="sourceType") + """The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: \"inline\" and \"reference\".""" + value: str = rest_field() + """The content of the document, given either inline (as a string) or as a reference (URI). + Required.""" + + @overload + def __init__( + self, + *, + source_type: Union[str, "_models.DocumentContentSourceType"], + value: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Encounter(_model_base.Model): + """visit/encounter information. + + All required parameters must be populated in order to send to server. + + :ivar id: The id of the visit. Required. + :vartype id: str + :ivar period: Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end + to indicate the discharge time. + :vartype period: ~azure.healthinsights.patienttimeline.models.TimePeriod + :ivar class_property: The class of the encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + :vartype class_property: str or ~azure.healthinsights.patienttimeline.models.EncounterClass + """ + + id: str = rest_field() + """The id of the visit. Required.""" + period: Optional["_models.TimePeriod"] = rest_field() + """Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to + indicate the discharge time.""" + class_property: Optional[Union[str, "_models.EncounterClass"]] = rest_field(name="class") + """The class of the encounter. Known values are: \"inpatient\", \"ambulatory\", \"observation\", + \"emergency\", \"virtual\", and \"healthHome\".""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + period: Optional["_models.TimePeriod"] = None, + class_property: Optional[Union[str, "_models.EncounterClass"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Error(_model_base.Model): + """The error object. + + All required parameters must be populated in order to send to server. + + :ivar code: One of a server-defined set of error codes. Required. + :vartype code: str + :ivar message: A human-readable representation of the error. Required. + :vartype message: str + :ivar target: The target of the error. + :vartype target: str + :ivar details: An array of details about specific errors that led to this reported error. + :vartype details: list[~azure.healthinsights.patienttimeline.models.Error] + :ivar innererror: An object containing more specific information than the current object about + the error. + :vartype innererror: ~azure.healthinsights.patienttimeline.models.InnerError + """ + + code: str = rest_field() + """One of a server-defined set of error codes. Required.""" + message: str = rest_field() + """A human-readable representation of the error. Required.""" + target: Optional[str] = rest_field() + """The target of the error.""" + details: Optional[List["_models.Error"]] = rest_field() + """An array of details about specific errors that led to this reported error.""" + innererror: Optional["_models.InnerError"] = rest_field() + """An object containing more specific information than the current object about the error.""" + + @overload + def __init__( + self, + *, + code: str, + message: str, + target: Optional[str] = None, + details: Optional[List["_models.Error"]] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Extension(Element): # pylint: disable=too-many-instance-attributes + """Base for all elements + Based on `FHIR Element `_. + + All required parameters must be populated in order to send to server. + + :ivar url: Source of the definition for the extension code - a logical name or a URL. Required. + :vartype url: str + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.patienttimeline.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.patienttimeline.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.patienttimeline.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.patienttimeline.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.patienttimeline.models.Reference + """ + + url: str = rest_field() + """Source of the definition for the extension code - a logical name or a URL. Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + + @overload + def __init__( + self, + *, + url: str, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class HealthInsightsOperationStatus(_model_base.Model): + """Provides status details for long running operations. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: The unique ID of the operation. Required. + :vartype id: str + :ivar status: The status of the operation. Required. Known values are: "notStarted", "running", + "succeeded", "failed", and "canceled". + :vartype status: str or ~azure.healthinsights.patienttimeline.models.JobStatus + :ivar created_date_time: The date and time when the processing job was created. + :vartype created_date_time: ~datetime.datetime + :ivar expiration_date_time: The date and time when the processing job is set to expire. + :vartype expiration_date_time: ~datetime.datetime + :ivar last_update_date_time: The date and time when the processing job was last updated. + :vartype last_update_date_time: ~datetime.datetime + :ivar error: Error object that describes the error when status is "Failed". + :vartype error: ~azure.healthinsights.patienttimeline.models.Error + :ivar result: The result of the operation. + :vartype result: ~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceResult + """ + + id: str = rest_field(visibility=["read"]) + """The unique ID of the operation. Required.""" + status: Union[str, "_models.JobStatus"] = rest_field(visibility=["read"]) + """The status of the operation. Required. Known values are: \"notStarted\", \"running\", + \"succeeded\", \"failed\", and \"canceled\".""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was created.""" + expiration_date_time: Optional[datetime.datetime] = rest_field( + name="expirationDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job is set to expire.""" + last_update_date_time: Optional[datetime.datetime] = rest_field( + name="lastUpdateDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was last updated.""" + error: Optional["_models.Error"] = rest_field() + """Error object that describes the error when status is \"Failed\".""" + result: Optional["_models.PatientTimelineInferenceResult"] = rest_field() + """The result of the operation.""" + + @overload + def __init__( + self, + *, + error: Optional["_models.Error"] = None, + result: Optional["_models.PatientTimelineInferenceResult"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Identifier(Element): + """An identifier intended for computation + Based on `FHIR Identifier `_. + + :ivar use: usual | official | temp | secondary | old (If known). + :vartype use: str + :ivar type: Description of identifier. + :vartype type: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar system: The namespace for the identifier value. + :vartype system: str + :ivar value: The value that is unique. + :vartype value: str + :ivar period: Time period when id is/was valid for use. + :vartype period: ~azure.healthinsights.patienttimeline.models.Period + :ivar assigner: Organization that issued id (may be just text). + :vartype assigner: ~azure.healthinsights.patienttimeline.models.Reference + """ + + use: Optional[str] = rest_field() + """usual | official | temp | secondary | old (If known).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Description of identifier.""" + system: Optional[str] = rest_field() + """The namespace for the identifier value.""" + value: Optional[str] = rest_field() + """The value that is unique.""" + period: Optional["_models.Period"] = rest_field() + """Time period when id is/was valid for use.""" + assigner: Optional["_models.Reference"] = rest_field() + """Organization that issued id (may be just text).""" + + @overload + def __init__( + self, + *, + use: Optional[str] = None, + type: Optional["_models.CodeableConcept"] = None, + system: Optional[str] = None, + value: Optional[str] = None, + period: Optional["_models.Period"] = None, + assigner: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class InnerError(_model_base.Model): + """An object containing more specific information about the error. As per Microsoft One API + guidelines - + https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + + :ivar code: One of a server-defined set of error codes. + :vartype code: str + :ivar innererror: Inner error. + :vartype innererror: ~azure.healthinsights.patienttimeline.models.InnerError + """ + + code: Optional[str] = rest_field() + """One of a server-defined set of error codes.""" + innererror: Optional["_models.InnerError"] = rest_field() + """Inner error.""" + + @overload + def __init__( + self, + *, + code: Optional[str] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Meta(_model_base.Model): + """Metadata about a resource + Based on `FHIR Meta `_. + + :ivar version_id: The version specific identifier, as it appears in the version portion of the + URL. This value changes when the resource is created, updated, or deleted. + :vartype version_id: str + :ivar last_updated: When the resource last changed - e.g. when the version changed. + :vartype last_updated: str + :ivar source: A uri that identifies the source system of the resource. This provides a minimal + amount of Provenance information that can be used to track or differentiate the source of + information in the resource. The source may identify another FHIR server, document, message, + database, etc. + :vartype source: str + :ivar profile: A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_. + :vartype profile: list[str] + :ivar security: Security labels applied to this resource. These tags connect specific resources + to the overall security policy and infrastructure. + :vartype security: list[~azure.healthinsights.patienttimeline.models.Coding] + :ivar tag: Tags applied to this resource. Tags are intended to be used to identify and relate + resources to process and workflow, and applications are not required to consider the tags when + interpreting the meaning of a resource. + :vartype tag: list[~azure.healthinsights.patienttimeline.models.Coding] + """ + + version_id: Optional[str] = rest_field(name="versionId") + """The version specific identifier, as it appears in the version portion of the URL. This value + changes when the resource is created, updated, or deleted.""" + last_updated: Optional[str] = rest_field(name="lastUpdated") + """When the resource last changed - e.g. when the version changed.""" + source: Optional[str] = rest_field() + """A uri that identifies the source system of the resource. This provides a minimal amount of + Provenance information that can be used to track or differentiate the source of information in + the resource. The source may identify another FHIR server, document, message, database, etc.""" + profile: Optional[List[str]] = rest_field() + """A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_.""" + security: Optional[List["_models.Coding"]] = rest_field() + """Security labels applied to this resource. These tags connect specific resources to the overall + security policy and infrastructure.""" + tag: Optional[List["_models.Coding"]] = rest_field() + """Tags applied to this resource. Tags are intended to be used to identify and relate resources to + process and workflow, and applications are not required to consider the tags when interpreting + the meaning of a resource.""" + + @overload + def __init__( + self, + *, + version_id: Optional[str] = None, + last_updated: Optional[str] = None, + source: Optional[str] = None, + profile: Optional[List[str]] = None, + security: Optional[List["_models.Coding"]] = None, + tag: Optional[List["_models.Coding"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Narrative(Element): + """Any resource that is a `DomainResource `_ may + include a human-readable narrative that contains a summary of the resource and may be used to + represent the content of the resource to a human. + Based on `FHIR Narrative `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar status: generated, extensions, additional, empty. Required. + :vartype status: str + :ivar div: xhtml. Required. + :vartype div: str + """ + + status: str = rest_field() + """generated, extensions, additional, empty. Required.""" + div: str = rest_field() + """xhtml. Required.""" + + @overload + def __init__( + self, + *, + status: str, + div: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Observation(DomainResource, discriminator="Observation"): # pylint: disable=too-many-instance-attributes + """Detailed information about observations + Based on `FHIR Observation `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.patienttimeline.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.patienttimeline.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.patienttimeline.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "Observation". + :vartype resource_type: str + :ivar identifier: Business Identifier for observation. + :vartype identifier: list[~azure.healthinsights.patienttimeline.models.Identifier] + :ivar status: registered | preliminary | final | amended +. Required. Known values are: + "registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", + and "unknown". + :vartype status: str or ~azure.healthinsights.patienttimeline.models.ObservationStatusCodeType + :ivar category: Classification of type of observation. + :vartype category: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar code: Type of observation (code / type). Required. + :vartype code: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar subject: Who and/or what the observation is about. + :vartype subject: ~azure.healthinsights.patienttimeline.models.Reference + :ivar encounter: Healthcare event during which this observation is made. + :vartype encounter: ~azure.healthinsights.patienttimeline.models.Reference + :ivar effective_date_time: Clinically relevant time/time-period for observation. + :vartype effective_date_time: str + :ivar effective_period: Clinically relevant time/time-period for observation. + :vartype effective_period: ~azure.healthinsights.patienttimeline.models.Period + :ivar effective_instant: Clinically relevant time/time-period for observation. + :vartype effective_instant: str + :ivar issued: Date/Time this version was made available. + :vartype issued: str + :ivar value_quantity: Actual result. + :vartype value_quantity: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar value_codeable_concept: Actual result. + :vartype value_codeable_concept: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar value_string: Actual result. + :vartype value_string: str + :ivar value_boolean: Actual result. + :vartype value_boolean: bool + :ivar value_integer: Actual result. + :vartype value_integer: int + :ivar value_range: Actual result. + :vartype value_range: ~azure.healthinsights.patienttimeline.models.Range + :ivar value_ratio: Actual result. + :vartype value_ratio: ~azure.healthinsights.patienttimeline.models.Ratio + :ivar value_sampled_data: Actual result. + :vartype value_sampled_data: ~azure.healthinsights.patienttimeline.models.SampledData + :ivar value_time: Actual result. + :vartype value_time: ~datetime.time + :ivar value_date_time: Actual result. + :vartype value_date_time: str + :ivar value_period: Actual result. + :vartype value_period: ~azure.healthinsights.patienttimeline.models.Period + :ivar data_absent_reason: Why the result is missing. + :vartype data_absent_reason: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar interpretation: High, low, normal, etc. + :vartype interpretation: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar note: Comments about the observation. + :vartype note: list[~azure.healthinsights.patienttimeline.models.Annotation] + :ivar body_site: Observed body part. + :vartype body_site: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar method: How it was done. + :vartype method: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar reference_range: Provides guide for interpretation. + :vartype reference_range: + list[~azure.healthinsights.patienttimeline.models.ObservationReferenceRange] + :ivar has_member: Related resource that belongs to the Observation group. + :vartype has_member: list[~azure.healthinsights.patienttimeline.models.Reference] + :ivar derived_from: Related measurements the observation is made from. + :vartype derived_from: list[~azure.healthinsights.patienttimeline.models.Reference] + :ivar component: Component results. + :vartype component: list[~azure.healthinsights.patienttimeline.models.ObservationComponent] + """ + + resource_type: Literal["Observation"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"Observation\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """Business Identifier for observation.""" + status: Union[str, "_models.ObservationStatusCodeType"] = rest_field() + """registered | preliminary | final | amended +. Required. Known values are: \"registered\", + \"preliminary\", \"final\", \"amended\", \"corrected\", \"cancelled\", \"entered-in-error\", + and \"unknown\".""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """Classification of type of observation.""" + code: "_models.CodeableConcept" = rest_field() + """Type of observation (code / type). Required.""" + subject: Optional["_models.Reference"] = rest_field() + """Who and/or what the observation is about.""" + encounter: Optional["_models.Reference"] = rest_field() + """Healthcare event during which this observation is made.""" + effective_date_time: Optional[str] = rest_field(name="effectiveDateTime") + """Clinically relevant time/time-period for observation.""" + effective_period: Optional["_models.Period"] = rest_field(name="effectivePeriod") + """Clinically relevant time/time-period for observation.""" + effective_instant: Optional[str] = rest_field(name="effectiveInstant") + """Clinically relevant time/time-period for observation.""" + issued: Optional[str] = rest_field() + """Date/Time this version was made available.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Actual result.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Actual result.""" + value_string: Optional[str] = rest_field(name="valueString") + """Actual result.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Actual result.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Actual result.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Actual result.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Actual result.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Actual result.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Actual result.""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Actual result.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Actual result.""" + data_absent_reason: Optional["_models.CodeableConcept"] = rest_field(name="dataAbsentReason") + """Why the result is missing.""" + interpretation: Optional[List["_models.CodeableConcept"]] = rest_field() + """High, low, normal, etc.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Comments about the observation.""" + body_site: Optional["_models.CodeableConcept"] = rest_field(name="bodySite") + """Observed body part.""" + method: Optional["_models.CodeableConcept"] = rest_field() + """How it was done.""" + reference_range: Optional[List["_models.ObservationReferenceRange"]] = rest_field(name="referenceRange") + """Provides guide for interpretation.""" + has_member: Optional[List["_models.Reference"]] = rest_field(name="hasMember") + """Related resource that belongs to the Observation group.""" + derived_from: Optional[List["_models.Reference"]] = rest_field(name="derivedFrom") + """Related measurements the observation is made from.""" + component: Optional[List["_models.ObservationComponent"]] = rest_field() + """Component results.""" + + @overload + def __init__( + self, + *, + status: Union[str, "_models.ObservationStatusCodeType"], + code: "_models.CodeableConcept", + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + subject: Optional["_models.Reference"] = None, + encounter: Optional["_models.Reference"] = None, + effective_date_time: Optional[str] = None, + effective_period: Optional["_models.Period"] = None, + effective_instant: Optional[str] = None, + issued: Optional[str] = None, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + data_absent_reason: Optional["_models.CodeableConcept"] = None, + interpretation: Optional[List["_models.CodeableConcept"]] = None, + note: Optional[List["_models.Annotation"]] = None, + body_site: Optional["_models.CodeableConcept"] = None, + method: Optional["_models.CodeableConcept"] = None, + reference_range: Optional[List["_models.ObservationReferenceRange"]] = None, + has_member: Optional[List["_models.Reference"]] = None, + derived_from: Optional[List["_models.Reference"]] = None, + component: Optional[List["_models.ObservationComponent"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, resource_type="Observation", **kwargs) + + +class ObservationComponent(Element): # pylint: disable=too-many-instance-attributes + """Component results + Based on `FHIR Observation.component `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar code: Type of component observation (code / type). Required. + :vartype code: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.patienttimeline.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.patienttimeline.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.patienttimeline.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.patienttimeline.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.patienttimeline.models.Reference + :ivar data_absent_reason: Why the component result is missing. + :vartype data_absent_reason: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar interpretation: High, low, normal, etc. + :vartype interpretation: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar reference_range: Provides guide for interpretation of component result. + :vartype reference_range: + list[~azure.healthinsights.patienttimeline.models.ObservationReferenceRange] + """ + + code: "_models.CodeableConcept" = rest_field() + """Type of component observation (code / type). Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + data_absent_reason: Optional["_models.CodeableConcept"] = rest_field(name="dataAbsentReason") + """Why the component result is missing.""" + interpretation: Optional[List["_models.CodeableConcept"]] = rest_field() + """High, low, normal, etc.""" + reference_range: Optional[List["_models.ObservationReferenceRange"]] = rest_field(name="referenceRange") + """Provides guide for interpretation of component result.""" + + @overload + def __init__( + self, + *, + code: "_models.CodeableConcept", + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + data_absent_reason: Optional["_models.CodeableConcept"] = None, + interpretation: Optional[List["_models.CodeableConcept"]] = None, + reference_range: Optional[List["_models.ObservationReferenceRange"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ObservationReferenceRange(_model_base.Model): + """Provides guide for interpretation of component result + Based on `FHIR Observation.referenceRange `_. + + :ivar low: Low Range, if relevant. + :vartype low: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar high: High Range, if relevant. + :vartype high: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar type: Reference range qualifier. + :vartype type: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar applies_to: Reference range population. + :vartype applies_to: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar age: Applicable age range, if relevant. + :vartype age: ~azure.healthinsights.patienttimeline.models.Range + :ivar text: Text based reference range in an observation. + :vartype text: str + """ + + low: Optional["_models.Quantity"] = rest_field() + """Low Range, if relevant.""" + high: Optional["_models.Quantity"] = rest_field() + """High Range, if relevant.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Reference range qualifier.""" + applies_to: Optional[List["_models.CodeableConcept"]] = rest_field(name="appliesTo") + """Reference range population.""" + age: Optional["_models.Range"] = rest_field() + """Applicable age range, if relevant.""" + text: Optional[str] = rest_field() + """Text based reference range in an observation.""" + + @overload + def __init__( + self, + *, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, + type: Optional["_models.CodeableConcept"] = None, + applies_to: Optional[List["_models.CodeableConcept"]] = None, + age: Optional["_models.Range"] = None, + text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OrderedProcedure(_model_base.Model): + """Procedure information. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar code: Procedure code. + :vartype code: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar description: Procedure description. + :vartype description: str + """ + + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Procedure code.""" + description: Optional[str] = rest_field() + """Procedure description.""" + + @overload + def __init__( + self, + *, + extension: Optional[List["_models.Extension"]] = None, + code: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientDetails(_model_base.Model): + """Patient structured information, including demographics and known structured clinical + information. + + :ivar sex: The patient's sex. Known values are: "female", "male", and "unspecified". + :vartype sex: str or ~azure.healthinsights.patienttimeline.models.PatientSex + :ivar birth_date: The patient's date of birth. + :vartype birth_date: ~datetime.date + :ivar clinical_info: Known clinical information for the patient, structured. + :vartype clinical_info: list[~azure.healthinsights.patienttimeline.models.Resource] + """ + + sex: Optional[Union[str, "_models.PatientSex"]] = rest_field() + """The patient's sex. Known values are: \"female\", \"male\", and \"unspecified\".""" + birth_date: Optional[datetime.date] = rest_field(name="birthDate") + """The patient's date of birth.""" + clinical_info: Optional[List["_models.Resource"]] = rest_field(name="clinicalInfo") + """Known clinical information for the patient, structured.""" + + @overload + def __init__( + self, + *, + sex: Optional[Union[str, "_models.PatientSex"]] = None, + birth_date: Optional[datetime.date] = None, + clinical_info: Optional[List["_models.Resource"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientDocument(_model_base.Model): + """A clinical document related to a patient. Document here is in the wide sense - not just a text + document (note). + + All required parameters must be populated in order to send to server. + + :ivar type: The type of the patient document, such as 'note' (text document) or 'fhirBundle' + (FHIR JSON document). Required. Known values are: "note", "fhirBundle", "dicom", and + "genomicSequencing". + :vartype type: str or ~azure.healthinsights.patienttimeline.models.DocumentType + :ivar clinical_type: The type of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", "procedure", "progress", + "laboratory", and "pathologyReport". + :vartype clinical_type: str or + ~azure.healthinsights.patienttimeline.models.ClinicalDocumentType + :ivar id: A given identifier for the document. Has to be unique across all documents for a + single patient. Required. + :vartype id: str + :ivar language: A 2 letter ISO 639-1 representation of the language of the document. + :vartype language: str + :ivar created_date_time: The date and time when the document was created. + :vartype created_date_time: ~datetime.datetime + :ivar authors: Document author(s). + :vartype authors: list[~azure.healthinsights.patienttimeline.models.DocumentAuthor] + :ivar specialty_type: specialty type the document. Known values are: "pathology" and + "radiology". + :vartype specialty_type: str or ~azure.healthinsights.patienttimeline.models.SpecialtyType + :ivar administrative_metadata: Administrative metadata for the document. + :vartype administrative_metadata: + ~azure.healthinsights.patienttimeline.models.DocumentAdministrativeMetadata + :ivar content: The content of the patient document. Required. + :vartype content: ~azure.healthinsights.patienttimeline.models.DocumentContent + """ + + type: Union[str, "_models.DocumentType"] = rest_field() + """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON + document). Required. Known values are: \"note\", \"fhirBundle\", \"dicom\", and + \"genomicSequencing\".""" + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = rest_field(name="clinicalType") + """The type of the clinical document. Known values are: \"consultation\", \"dischargeSummary\", + \"historyAndPhysical\", \"radiologyReport\", \"procedure\", \"progress\", \"laboratory\", and + \"pathologyReport\".""" + id: str = rest_field() + """A given identifier for the document. Has to be unique across all documents for a single + patient. Required.""" + language: Optional[str] = rest_field() + """A 2 letter ISO 639-1 representation of the language of the document.""" + created_date_time: Optional[datetime.datetime] = rest_field(name="createdDateTime", format="rfc3339") + """The date and time when the document was created.""" + authors: Optional[List["_models.DocumentAuthor"]] = rest_field() + """Document author(s).""" + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = rest_field(name="specialtyType") + """specialty type the document. Known values are: \"pathology\" and \"radiology\".""" + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = rest_field( + name="administrativeMetadata" + ) + """Administrative metadata for the document.""" + content: "_models.DocumentContent" = rest_field() + """The content of the patient document. Required.""" + + @overload + def __init__( + self, + *, + type: Union[str, "_models.DocumentType"], + id: str, # pylint: disable=redefined-builtin + content: "_models.DocumentContent", + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = None, + language: Optional[str] = None, + created_date_time: Optional[datetime.datetime] = None, + authors: Optional[List["_models.DocumentAuthor"]] = None, + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = None, + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientRecord(_model_base.Model): + """A patient record, including their clinical information and data. + + All required parameters must be populated in order to send to server. + + :ivar id: A given identifier for the patient. Has to be unique across all patients in a single + request. Required. + :vartype id: str + :ivar info: Patient structured information, including demographics and known structured + clinical information. + :vartype info: ~azure.healthinsights.patienttimeline.models.PatientDetails + :ivar encounters: Patient encounters/visits. + :vartype encounters: list[~azure.healthinsights.patienttimeline.models.Encounter] + :ivar patient_documents: Patient unstructured clinical data, given as documents. + :vartype patient_documents: list[~azure.healthinsights.patienttimeline.models.PatientDocument] + """ + + id: str = rest_field() + """A given identifier for the patient. Has to be unique across all patients in a single request. + Required.""" + info: Optional["_models.PatientDetails"] = rest_field() + """Patient structured information, including demographics and known structured clinical + information.""" + encounters: Optional[List["_models.Encounter"]] = rest_field() + """Patient encounters/visits.""" + patient_documents: Optional[List["_models.PatientDocument"]] = rest_field(name="patientDocuments") + """Patient unstructured clinical data, given as documents.""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + info: Optional["_models.PatientDetails"] = None, + encounters: Optional[List["_models.Encounter"]] = None, + patient_documents: Optional[List["_models.PatientDocument"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientTimelineData(_model_base.Model): + """The body of the Patient Timeline request. + + All required parameters must be populated in order to send to server. + + :ivar patients: The list of patients, including their clinical information and data. Required. + :vartype patients: list[~azure.healthinsights.patienttimeline.models.PatientRecord] + :ivar configuration: Configuration affecting the Patient Timeline model's inference. + :vartype configuration: + ~azure.healthinsights.patienttimeline.models.PatientTimelineModelConfiguration + """ + + patients: List["_models.PatientRecord"] = rest_field() + """The list of patients, including their clinical information and data. Required.""" + configuration: Optional["_models.PatientTimelineModelConfiguration"] = rest_field() + """Configuration affecting the Patient Timeline model's inference.""" + + @overload + def __init__( + self, + *, + patients: List["_models.PatientRecord"], + configuration: Optional["_models.PatientTimelineModelConfiguration"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientTimelineInference(_model_base.Model): + """An inference made by the Patient Timeline model regarding a patient. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar type: The type of the Patient Timeline inference. Required. Known values are: + "timelineEvent" and "summaryItem". + :vartype type: str or ~azure.healthinsights.patienttimeline.models.PatientTimelineInferenceType + :ivar resource: FHIR 4.0 representation of the piece of clinical info. + additional dependent resources maybe contained (e.g. MedicationStatement may contain + Medication) + -- In the SDK we will have custom mapping to map this type to JsonObject. + :vartype resource: ~azure.healthinsights.patienttimeline.models.DomainResource + :ivar period: Time range relevant to this Timeline inference. + :vartype period: ~azure.healthinsights.patienttimeline.models.TimePeriod + """ + + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + type: Union[str, "_models.PatientTimelineInferenceType"] = rest_field() + """The type of the Patient Timeline inference. Required. Known values are: \"timelineEvent\" and + \"summaryItem\".""" + resource: Optional["_models.DomainResource"] = rest_field() + """FHIR 4.0 representation of the piece of clinical info. + additional dependent resources maybe contained (e.g. MedicationStatement may contain + Medication) + -- In the SDK we will have custom mapping to map this type to JsonObject.""" + period: Optional["_models.TimePeriod"] = rest_field() + """Time range relevant to this Timeline inference.""" + + @overload + def __init__( + self, + *, + type: Union[str, "_models.PatientTimelineInferenceType"], + extension: Optional[List["_models.Extension"]] = None, + resource: Optional["_models.DomainResource"] = None, + period: Optional["_models.TimePeriod"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientTimelineInferenceResult(_model_base.Model): + """The inference results for the Patient Timeline request. + + All required parameters must be populated in order to send to server. + + :ivar patient_results: Results for the patients given in the request. Required. + :vartype patient_results: + list[~azure.healthinsights.patienttimeline.models.PatientTimelinePatientResult] + :ivar model_version: The version of the model used for inference, expressed as the model date. + Required. + :vartype model_version: str + """ + + patient_results: List["_models.PatientTimelinePatientResult"] = rest_field(name="patientResults") + """Results for the patients given in the request. Required.""" + model_version: str = rest_field(name="modelVersion") + """The version of the model used for inference, expressed as the model date. Required.""" + + @overload + def __init__( + self, + *, + patient_results: List["_models.PatientTimelinePatientResult"], + model_version: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientTimelineModelConfiguration(_model_base.Model): + """Configuration affecting the Patient Timeline model's inference. + + :ivar verbose: An indication whether the model should produce verbose output. + :vartype verbose: bool + :ivar include_evidence: An indication whether the model's output should include evidence for + the inferences. + :vartype include_evidence: bool + """ + + verbose: Optional[bool] = rest_field() + """An indication whether the model should produce verbose output.""" + include_evidence: Optional[bool] = rest_field(name="includeEvidence") + """An indication whether the model's output should include evidence for the inferences.""" + + @overload + def __init__( + self, + *, + verbose: Optional[bool] = None, + include_evidence: Optional[bool] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientTimelinePatientResult(_model_base.Model): + """The results of the model's work for a single patient. + + All required parameters must be populated in order to send to server. + + :ivar patient_id: The identifier given for the patient in the request. Required. + :vartype patient_id: str + :ivar inferences: The model's inferences for the given patient. Required. + :vartype inferences: + list[~azure.healthinsights.patienttimeline.models.PatientTimelineInference] + """ + + patient_id: str = rest_field(name="patientId") + """The identifier given for the patient in the request. Required.""" + inferences: List["_models.PatientTimelineInference"] = rest_field() + """The model's inferences for the given patient. Required.""" + + @overload + def __init__( + self, + *, + patient_id: str, + inferences: List["_models.PatientTimelineInference"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Period(Element): + """A time period defined by a start and end date and optionally time + Based on `FHIR Period `_. + + :ivar start: Starting time with inclusive boundary. + :vartype start: str + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: str + """ + + start: Optional[str] = rest_field() + """Starting time with inclusive boundary.""" + end: Optional[str] = rest_field() + """End time with inclusive boundary, if not ongoing.""" + + @overload + def __init__( + self, + *, + start: Optional[str] = None, + end: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Quantity(Element): + """A measured or measurable amount + Based on `FHIR Quantity `_. + + :ivar value: Numerical value (with implicit precision). + :vartype value: float + :ivar comparator: < | <= | >= | > - how to understand the value. + :vartype comparator: str + :ivar unit: Unit representation. + :vartype unit: str + :ivar system: System that defines coded unit form. + :vartype system: str + :ivar code: Coded form of the unit. + :vartype code: str + """ + + value: Optional[float] = rest_field() + """Numerical value (with implicit precision).""" + comparator: Optional[str] = rest_field() + """< | <= | >= | > - how to understand the value.""" + unit: Optional[str] = rest_field() + """Unit representation.""" + system: Optional[str] = rest_field() + """System that defines coded unit form.""" + code: Optional[str] = rest_field() + """Coded form of the unit.""" + + @overload + def __init__( + self, + *, + value: Optional[float] = None, + comparator: Optional[str] = None, + unit: Optional[str] = None, + system: Optional[str] = None, + code: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Range(Element): + """A set of ordered Quantities defined by a low and high limit + Based on `FHIR Range `_. + + :ivar low: Low limit. + :vartype low: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar high: High limit. + :vartype high: ~azure.healthinsights.patienttimeline.models.Quantity + """ + + low: Optional["_models.Quantity"] = rest_field() + """Low limit.""" + high: Optional["_models.Quantity"] = rest_field() + """High limit.""" + + @overload + def __init__( + self, + *, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Ratio(Element): + """A ratio of two Quantity values - a numerator and a denominator + Based on `FHIR Ratio `_. + + :ivar numerator: Numerator value. + :vartype numerator: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar denominator: Denominator value. + :vartype denominator: ~azure.healthinsights.patienttimeline.models.Quantity + """ + + numerator: Optional["_models.Quantity"] = rest_field() + """Numerator value.""" + denominator: Optional["_models.Quantity"] = rest_field() + """Denominator value.""" + + @overload + def __init__( + self, + *, + numerator: Optional["_models.Quantity"] = None, + denominator: Optional["_models.Quantity"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Reference(Element): + """A reference from one resource to another + Based on `FHIR Reference `_. + + :ivar reference: Literal reference, Relative, internal or absolute URL. + :vartype reference: str + :ivar type: Type the reference refers to (e.g. "Patient"). + :vartype type: str + :ivar identifier: Logical reference, when literal reference is not known. + :vartype identifier: ~azure.healthinsights.patienttimeline.models.Identifier + :ivar display: Text alternative for the resource. + :vartype display: str + """ + + reference: Optional[str] = rest_field() + """Literal reference, Relative, internal or absolute URL.""" + type: Optional[str] = rest_field() + """Type the reference refers to (e.g. \"Patient\").""" + identifier: Optional["_models.Identifier"] = rest_field() + """Logical reference, when literal reference is not known.""" + display: Optional[str] = rest_field() + """Text alternative for the resource.""" + + @overload + def __init__( + self, + *, + reference: Optional[str] = None, + type: Optional[str] = None, + identifier: Optional["_models.Identifier"] = None, + display: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResearchStudy(DomainResource, discriminator="ResearchStudy"): # pylint: disable=too-many-instance-attributes + """Detailed information about Research Study + Based on `FHIR ResearchStudy `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.patienttimeline.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.patienttimeline.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.patienttimeline.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.patienttimeline.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "ResearchStudy". + :vartype resource_type: str + :ivar identifier: Business Identifier for study. + :vartype identifier: list[~azure.healthinsights.patienttimeline.models.Identifier] + :ivar title: Name for this study. + :vartype title: str + :ivar protocol: Steps followed in executing study. + :vartype protocol: list[~azure.healthinsights.patienttimeline.models.Reference] + :ivar part_of: Part of larger study. + :vartype part_of: list[~azure.healthinsights.patienttimeline.models.Reference] + :ivar status: active | administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | in-review | + temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", "administratively-completed", "approved", + "closed-to-accrual", "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", "temporarily-closed-to-accrual-and-intervention", + and "withdrawn". + :vartype status: str or + ~azure.healthinsights.patienttimeline.models.ResearchStudyStatusCodeType + :ivar primary_purpose_type: treatment | prevention | diagnostic | supportive-care | screening | + health-services-research | basic-science | device-feasibility. + :vartype primary_purpose_type: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar phase: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | + phase-3 | phase-4. + :vartype phase: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar category: Classifications for the study. + :vartype category: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar focus: Drugs, devices, etc. under study. + :vartype focus: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar condition: Condition being studied. + :vartype condition: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar contact: Contact details for the study. + :vartype contact: list[~azure.healthinsights.patienttimeline.models.ContactDetail] + :ivar keyword: Used to search for the study. + :vartype keyword: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar location: Geographic region(s) for study. + :vartype location: list[~azure.healthinsights.patienttimeline.models.CodeableConcept] + :ivar description: What this is study doing. + :vartype description: str + :ivar enrollment: Inclusion & exclusion criteria. + :vartype enrollment: list[~azure.healthinsights.patienttimeline.models.Reference] + :ivar period: When the study began and ended. + :vartype period: ~azure.healthinsights.patienttimeline.models.Period + :ivar sponsor: Organization that initiates and is legally responsible for the study. + :vartype sponsor: ~azure.healthinsights.patienttimeline.models.Reference + :ivar principal_investigator: Researcher who oversees multiple aspects of the study. + :vartype principal_investigator: ~azure.healthinsights.patienttimeline.models.Reference + :ivar site: Facility where study activities are conducted. + :vartype site: list[~azure.healthinsights.patienttimeline.models.Reference] + :ivar reason_stopped: accrual-goal-met | closed-due-to-toxicity | + closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design. + :vartype reason_stopped: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar note: Comments made about the study. + :vartype note: list[~azure.healthinsights.patienttimeline.models.Annotation] + :ivar arm: Defined path through the study for a subject. + :vartype arm: list[~azure.healthinsights.patienttimeline.models.ResearchStudyArm] + :ivar objective: A goal for the study. + :vartype objective: list[~azure.healthinsights.patienttimeline.models.ResearchStudyObjective] + """ + + resource_type: Literal["ResearchStudy"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"ResearchStudy\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """Business Identifier for study.""" + title: Optional[str] = rest_field() + """Name for this study.""" + protocol: Optional[List["_models.Reference"]] = rest_field() + """Steps followed in executing study.""" + part_of: Optional[List["_models.Reference"]] = rest_field(name="partOf") + """Part of larger study.""" + status: Union[str, "_models.ResearchStudyStatusCodeType"] = rest_field() + """active | administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | in-review | + temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: \"active\", \"administratively-completed\", \"approved\", + \"closed-to-accrual\", \"closed-to-accrual-and-intervention\", \"completed\", \"disapproved\", + \"in-review\", \"temporarily-closed-to-accrual\", + \"temporarily-closed-to-accrual-and-intervention\", and \"withdrawn\".""" + primary_purpose_type: Optional["_models.CodeableConcept"] = rest_field(name="primaryPurposeType") + """treatment | prevention | diagnostic | supportive-care | screening | health-services-research | + basic-science | device-feasibility.""" + phase: Optional["_models.CodeableConcept"] = rest_field() + """n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | + phase-4.""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """Classifications for the study.""" + focus: Optional[List["_models.CodeableConcept"]] = rest_field() + """Drugs, devices, etc. under study.""" + condition: Optional[List["_models.CodeableConcept"]] = rest_field() + """Condition being studied.""" + contact: Optional[List["_models.ContactDetail"]] = rest_field() + """Contact details for the study.""" + keyword: Optional[List["_models.CodeableConcept"]] = rest_field() + """Used to search for the study.""" + location: Optional[List["_models.CodeableConcept"]] = rest_field() + """Geographic region(s) for study.""" + description: Optional[str] = rest_field() + """What this is study doing.""" + enrollment: Optional[List["_models.Reference"]] = rest_field() + """Inclusion & exclusion criteria.""" + period: Optional["_models.Period"] = rest_field() + """When the study began and ended.""" + sponsor: Optional["_models.Reference"] = rest_field() + """Organization that initiates and is legally responsible for the study.""" + principal_investigator: Optional["_models.Reference"] = rest_field(name="principalInvestigator") + """Researcher who oversees multiple aspects of the study.""" + site: Optional[List["_models.Reference"]] = rest_field() + """Facility where study activities are conducted.""" + reason_stopped: Optional["_models.CodeableConcept"] = rest_field(name="reasonStopped") + """accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | + temporarily-closed-per-study-design.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Comments made about the study.""" + arm: Optional[List["_models.ResearchStudyArm"]] = rest_field() + """Defined path through the study for a subject.""" + objective: Optional[List["_models.ResearchStudyObjective"]] = rest_field() + """A goal for the study.""" + + @overload + def __init__( + self, + *, + status: Union[str, "_models.ResearchStudyStatusCodeType"], + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + title: Optional[str] = None, + protocol: Optional[List["_models.Reference"]] = None, + part_of: Optional[List["_models.Reference"]] = None, + primary_purpose_type: Optional["_models.CodeableConcept"] = None, + phase: Optional["_models.CodeableConcept"] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + focus: Optional[List["_models.CodeableConcept"]] = None, + condition: Optional[List["_models.CodeableConcept"]] = None, + contact: Optional[List["_models.ContactDetail"]] = None, + keyword: Optional[List["_models.CodeableConcept"]] = None, + location: Optional[List["_models.CodeableConcept"]] = None, + description: Optional[str] = None, + enrollment: Optional[List["_models.Reference"]] = None, + period: Optional["_models.Period"] = None, + sponsor: Optional["_models.Reference"] = None, + principal_investigator: Optional["_models.Reference"] = None, + site: Optional[List["_models.Reference"]] = None, + reason_stopped: Optional["_models.CodeableConcept"] = None, + note: Optional[List["_models.Annotation"]] = None, + arm: Optional[List["_models.ResearchStudyArm"]] = None, + objective: Optional[List["_models.ResearchStudyObjective"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, resource_type="ResearchStudy", **kwargs) + + +class ResearchStudyArm(_model_base.Model): + """ResearchStudyArm. + + All required parameters must be populated in order to send to server. + + :ivar name: Label for study arm. Required. + :vartype name: str + :ivar type: Categorization of study arm. + :vartype type: ~azure.healthinsights.patienttimeline.models.CodeableConcept + :ivar description: Short explanation of study path. + :vartype description: str + """ + + name: str = rest_field() + """Label for study arm. Required.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Categorization of study arm.""" + description: Optional[str] = rest_field() + """Short explanation of study path.""" + + @overload + def __init__( + self, + *, + name: str, + type: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResearchStudyObjective(_model_base.Model): + """ResearchStudyObjective. + + All required parameters must be populated in order to send to server. + + :ivar name: Label for the objective. Required. + :vartype name: str + :ivar type: primary | secondary | exploratory. + :vartype type: ~azure.healthinsights.patienttimeline.models.CodeableConcept + """ + + name: str = rest_field() + """Label for the objective. Required.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """primary | secondary | exploratory.""" + + @overload + def __init__( + self, + *, + name: str, + type: Optional["_models.CodeableConcept"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SampledData(Element): + """A series of measurements taken by a device + Based on `FHIR SampledData `_. + + All required parameters must be populated in order to send to server. + + :ivar origin: Zero value and units. Required. + :vartype origin: ~azure.healthinsights.patienttimeline.models.Quantity + :ivar period: Number of milliseconds between samples. Required. + :vartype period: float + :ivar factor: Multiply data by this before adding to origin. + :vartype factor: float + :ivar lower_limit: Lower limit of detection. + :vartype lower_limit: float + :ivar upper_limit: Upper limit of detection. + :vartype upper_limit: float + :ivar dimensions: Number of sample points at each time point. Required. + :vartype dimensions: int + :ivar data: Decimal values with spaces, or "E" | "U" | "L". + :vartype data: str + """ + + origin: "_models.Quantity" = rest_field() + """Zero value and units. Required.""" + period: float = rest_field() + """Number of milliseconds between samples. Required.""" + factor: Optional[float] = rest_field() + """Multiply data by this before adding to origin.""" + lower_limit: Optional[float] = rest_field(name="lowerLimit") + """Lower limit of detection.""" + upper_limit: Optional[float] = rest_field(name="upperLimit") + """Upper limit of detection.""" + dimensions: int = rest_field() + """Number of sample points at each time point. Required.""" + data: Optional[str] = rest_field() + """Decimal values with spaces, or \"E\" | \"U\" | \"L\".""" + + @overload + def __init__( + self, + *, + origin: "_models.Quantity", + period: float, + dimensions: int, + factor: Optional[float] = None, + lower_limit: Optional[float] = None, + upper_limit: Optional[float] = None, + data: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TimePeriod(_model_base.Model): + """A duration of time during which an event is happening. + + :ivar start: Starting time with inclusive boundary. + :vartype start: ~datetime.datetime + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: ~datetime.datetime + """ + + start: Optional[datetime.datetime] = rest_field(format="rfc3339") + """Starting time with inclusive boundary.""" + end: Optional[datetime.datetime] = rest_field(format="rfc3339") + """End time with inclusive boundary, if not ongoing.""" + + @overload + def __init__( + self, + *, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_patch.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/models/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/py.typed b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/azure/healthinsights/patienttimeline/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/dev_requirements.txt b/sdk/healthinsights/azure-healthinsights-patienttimeline/dev_requirements.txt new file mode 100644 index 000000000000..ff12ab35dd01 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/dev_requirements.txt @@ -0,0 +1,4 @@ +-e ../../../tools/azure-devtools +-e ../../../tools/azure-sdk-tools +../../core/azure-core +aiohttp \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/sdk_packaging.toml b/sdk/healthinsights/azure-healthinsights-patienttimeline/sdk_packaging.toml new file mode 100644 index 000000000000..e7687fdae93b --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/sdk_packaging.toml @@ -0,0 +1,2 @@ +[packaging] +auto_update = false \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/setup.py b/sdk/healthinsights/azure-healthinsights-patienttimeline/setup.py new file mode 100644 index 000000000000..5f4a4bf1b433 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/setup.py @@ -0,0 +1,71 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# coding: utf-8 + +import os +import re +from setuptools import setup, find_packages + + +PACKAGE_NAME = "azure-healthinsights-patienttimeline" +PACKAGE_PPRINT_NAME = "Azure Health Insights - Patient Timeline" + +# a-b-c => a/b/c +package_folder_path = PACKAGE_NAME.replace("-", "/") + +# Version extraction inspired from 'requests' +with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: + version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) + +if not version: + raise RuntimeError("Cannot find version information") + + +setup( + name=PACKAGE_NAME, + version=version, + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), + long_description=open("README.md", "r").read(), + long_description_content_type="text/markdown", + license="MIT License", + author="Microsoft Corporation", + author_email="azpysdkhelp@microsoft.com", + url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", + keywords="azure, azure sdk", + classifiers=[ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "License :: OSI Approved :: MIT License", + ], + zip_safe=False, + packages=find_packages( + exclude=[ + "tests", + # Exclude packages that will be covered by PEP420 or nspkg + "azure", + "azure.healthinsights", + ] + ), + include_package_data=True, + package_data={ + "azure.healthinsights.patienttimeline": ["py.typed"], + }, + install_requires=[ + "isodate<1.0.0,>=0.6.1", + "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", + ], + python_requires=">=3.8", +) diff --git a/sdk/healthinsights/azure-healthinsights-patienttimeline/tsp-location.yaml b/sdk/healthinsights/azure-healthinsights-patienttimeline/tsp-location.yaml new file mode 100644 index 000000000000..3412aa799826 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-patienttimeline/tsp-location.yaml @@ -0,0 +1,7 @@ +commit: 70a4ccdd2be61ae5bc524250c70270b0f4f2b540 +directory: specification/ai/HealthInsights/HealthInsights.PatientTimeline +repo: Azure/azure-rest-api-specs +additionalDirectories: +- specification/ai/HealthInsights/HealthInsights.Common/ +- specification/ai/HealthInsights/HealthInsights.OpenAPI/ + diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/CHANGELOG.md b/sdk/healthinsights/azure-healthinsights-radiologyinsights/CHANGELOG.md new file mode 100644 index 000000000000..628743d283a9 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/CHANGELOG.md @@ -0,0 +1,5 @@ +# Release History + +## 1.0.0b1 (1970-01-01) + +- Initial version diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/LICENSE b/sdk/healthinsights/azure-healthinsights-radiologyinsights/LICENSE new file mode 100644 index 000000000000..63447fd8bbbf --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/MANIFEST.in b/sdk/healthinsights/azure-healthinsights-radiologyinsights/MANIFEST.in new file mode 100644 index 000000000000..d2fd55d2d2ad --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/MANIFEST.in @@ -0,0 +1,7 @@ +include *.md +include LICENSE +include azure/healthinsights/radiologyinsights/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/healthinsights/__init__.py \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/README.md b/sdk/healthinsights/azure-healthinsights-radiologyinsights/README.md new file mode 100644 index 000000000000..ffada5b551e2 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/README.md @@ -0,0 +1,45 @@ + + +# Azure Health Insights - Radiology Insights client library for Python + + +## Getting started + +### Installating the package + +```bash +python -m pip install azure-healthinsights-radiologyinsights +``` + +#### Prequisites + +- Python 3.8 or later is required to use this package. +- You need an [Azure subscription][azure_sub] to use this package. +- An existing Azure Health Insights - Radiology Insights instance. + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials +[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential +[pip]: https://pypi.org/project/pip/ +[azure_sub]: https://azure.microsoft.com/free/ + diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/_meta.json b/sdk/healthinsights/azure-healthinsights-radiologyinsights/_meta.json new file mode 100644 index 000000000000..fadf584fbe39 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "70a4ccdd2be61ae5bc524250c70270b0f4f2b540", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/ai/HealthInsights/HealthInsights.RadiologyInsights", + "@azure-tools/typespec-python": "0.21.0" +} \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/__init__.py new file mode 100644 index 000000000000..280758827c61 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/__init__.py @@ -0,0 +1,26 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import RadiologyInsightsClient +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "RadiologyInsightsClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_client.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_client.py new file mode 100644 index 000000000000..bc35db4ec225 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_client.py @@ -0,0 +1,100 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any + +from azure.core import PipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import RadiologyInsightsClientConfiguration +from ._operations import RadiologyInsightsClientOperationsMixin +from ._serialization import Deserializer, Serializer + + +class RadiologyInsightsClient( + RadiologyInsightsClientOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword + """RadiologyInsightsClient. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + _endpoint = "{endpoint}/health-insights" + self._config = RadiologyInsightsClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> "RadiologyInsightsClient": + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_configuration.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_configuration.py new file mode 100644 index 000000000000..25010ae54065 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_configuration.py @@ -0,0 +1,62 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from ._version import VERSION + + +class RadiologyInsightsClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for RadiologyInsightsClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + kwargs.setdefault("sdk_moniker", "healthinsights-radiologyinsights/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AzureKeyCredentialPolicy( + self.credential, "Ocp-Apim-Subscription-Key", **kwargs + ) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_model_base.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_model_base.py new file mode 100644 index 000000000000..1ddc071517d6 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_model_base.py @@ -0,0 +1,874 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except + +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import copy +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] # pylint: disable=protected-access + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): # pylint: disable=unsubscriptable-object + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = copy.deepcopy(data) + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: + ... + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: + ... + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + return self._data.popitem() + + def clear(self) -> None: + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: + ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: + ... + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument + # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' + mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") # pylint: disable=no-member + for k, v in mro_class.__annotations__.items() # pylint: disable=no-member + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) + + return super().__new__(cls) # pylint: disable=no-value-for-parameter + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): # pylint: disable=no-member + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: + for v in cls.__dict__.values(): + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access + return v._rest_name # pylint: disable=protected-access + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): # pylint: disable=no-member + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member + if mapped_cls == cls: + return cls(data) + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation or annotation in [int, float]: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + except AttributeError: + pass + + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) + + try: + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + obj: typing.Dict[typing.Any, typing.Any], + ): + if obj is None: + return obj + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + return functools.partial( + _deserialize_dict, + value_deserializer, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore + + def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, + ): + if obj is None: + return obj + return type(obj)( + _deserialize(deserializer, entry, module) + for entry, deserializer in zip(obj, entry_deserializers) + ) + + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + obj, + ): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + return functools.partial(_deserialize_sequence, deserializer) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): + try: + if value is None or isinstance(value, _Null): + return None + if deserializer is None: + return value + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/__init__.py new file mode 100644 index 000000000000..24be3b0c64fc --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/__init__.py @@ -0,0 +1,19 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import RadiologyInsightsClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "RadiologyInsightsClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_operations.py new file mode 100644 index 000000000000..36592c0f12cd --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_operations.py @@ -0,0 +1,2252 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import datetime +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload +import uuid + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.polling import LROPoller, NoPolling, PollingMethod +from azure.core.polling.base_polling import LROBasePolling +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._model_base import SdkJSONEncoder, _deserialize +from .._serialization import Serializer +from .._vendor import RadiologyInsightsClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_radiology_insights_infer_radiology_insights_request( # pylint: disable=name-too-long + **kwargs: Any, +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/radiology-insights/jobs" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if "Repeatability-Request-ID" not in _headers: + _headers["Repeatability-Request-ID"] = str(uuid.uuid4()) + if "Repeatability-First-Sent" not in _headers: + _headers["Repeatability-First-Sent"] = _SERIALIZER.serialize_data( + datetime.datetime.now(datetime.timezone.utc), "rfc-1123" + ) + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +class RadiologyInsightsClientOperationsMixin(RadiologyInsightsClientMixinABC): + def _infer_radiology_insights_initial( + self, body: Union[_models.RadiologyInsightsData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[JSON] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_radiology_insights_infer_radiology_insights_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(JSON, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_infer_radiology_insights( + self, body: _models.RadiologyInsightsData, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.RadiologyInsightsInferenceResult]: + # pylint: disable=line-too-long + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Required. + :type body: ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsData + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceOptions": { + "findingOptions": { + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide the sentence that contains the first token + of the finding's clinical indicator (i.e. the medical problem), if + there is one. This sentence is provided as an extension with url + 'ci_sentence', next to the token evidence. Default is false. + }, + "followupRecommendationOptions": { + "includeRecommendationsInReferences": bool, # + Optional. Include/Exclude follow-up recommendations in references to + a guideline or article. Default is false. + "includeRecommendationsWithNoSpecifiedModality": + bool, # Optional. Include/Exclude follow-up recommendations without + a specific radiology procedure. Default is false. + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide one or more sentences as evidence for the + recommendation, next to the token evidence. The start and end + positions of these sentences will be put in an extension with url + 'modality_sentences'. Default is false. + } + }, + "inferenceTypes": [ + "str" # Optional. This is a list of inference types to be + inferred for the current request. It could be used if only part of the + Radiology Insights inferences are required. If this list is omitted or + empty, the model will return all the inference types. + ], + "locale": "str", # Optional. Local for the model to use. If not + specified, the model will use the default locale. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + + @overload + def begin_infer_radiology_insights( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.RadiologyInsightsInferenceResult]: + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + + @overload + def begin_infer_radiology_insights( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.RadiologyInsightsInferenceResult]: + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + + @distributed_trace + def begin_infer_radiology_insights( + self, body: Union[_models.RadiologyInsightsData, JSON, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.RadiologyInsightsInferenceResult]: + # pylint: disable=line-too-long + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Is one of the following types: RadiologyInsightsData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsData or JSON or + IO[bytes] + :return: An instance of LROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceOptions": { + "findingOptions": { + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide the sentence that contains the first token + of the finding's clinical indicator (i.e. the medical problem), if + there is one. This sentence is provided as an extension with url + 'ci_sentence', next to the token evidence. Default is false. + }, + "followupRecommendationOptions": { + "includeRecommendationsInReferences": bool, # + Optional. Include/Exclude follow-up recommendations in references to + a guideline or article. Default is false. + "includeRecommendationsWithNoSpecifiedModality": + bool, # Optional. Include/Exclude follow-up recommendations without + a specific radiology procedure. Default is false. + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide one or more sentences as evidence for the + recommendation, next to the token evidence. The start and end + positions of these sentences will be put in an extension with url + 'modality_sentences'. Default is false. + } + }, + "inferenceTypes": [ + "str" # Optional. This is a list of inference types to be + inferred for the current request. It could be used if only part of the + Radiology Insights inferences are required. If this list is omitted or + empty, the model will return all the inference types. + ], + "locale": "str", # Optional. Local for the model to use. If not + specified, the model will use the default locale. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.RadiologyInsightsInferenceResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._infer_radiology_insights_initial( + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response_headers = {} + response = pipeline_response.http_response + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.RadiologyInsightsInferenceResult, response.json().get("result")) + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + return deserialized + + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method: PollingMethod = cast( + PollingMethod, LROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs) + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.RadiologyInsightsInferenceResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.RadiologyInsightsInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_patch.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_patch.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_serialization.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_serialization.py new file mode 100644 index 000000000000..2f781d740827 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_serialization.py @@ -0,0 +1,1998 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the ""Software""), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + TypeVar, + MutableMapping, + Type, + List, + Mapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +ModelType = TypeVar("ModelType", bound="Model") +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + + +try: + from datetime import timezone as _FixedOffset # type: ignore +except ImportError: # Python 2.7 + + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds() / 3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node.""" + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls: Type[ModelType], + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> ModelType: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result.update(objects[valuetype]._flatten_subtype(key, objects)) + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + Remove the polymorphic key from the initial data. + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + """ + return key.replace("\\.", ".") + + +class Serializer(object): + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises: SerializationError if serialization fails. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized.update(target_obj.additional_properties) + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises: SerializationError if serialization fails. + :raises: ValueError if data is None + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + elif data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, data.__class__) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param data: Object to be serialized. + :rtype: str + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + else: + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. + :rtype: list, str + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + elif obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises: SerializationError if format invalid + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError: + raise TypeError("Unix time object must be valid Datetime object.") + + +def rest_key_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(List[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key.""" + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + else: + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + else: # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer(object): + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + elif isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None: + return data + try: + attributes = response._attribute_map # type: ignore + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + else: + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param raw_data: Data to be processed. + :param content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param response: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [k for k, v in response._validation.items() if v.get("readonly")] + const = [k for k, v in response._validation.items() if v.get("constant")] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) + + def deserialize_data(self, data, data_type): + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + else: + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :rtype: dict + :raises: TypeError if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :rtype: str, int, float or bool + :raises: TypeError if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + else: + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + elif isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + elif attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + else: + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :rtype: long or int + :raises: ValueError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :rtype: TimeDelta + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :rtype: Date + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :rtype: Datetime + :raises: DeserializationError if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + else: + return date_obj diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_vendor.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_vendor.py new file mode 100644 index 000000000000..cea1829f79e3 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_vendor.py @@ -0,0 +1,26 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import RadiologyInsightsClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import PipelineClient + + from ._serialization import Deserializer, Serializer + + +class RadiologyInsightsClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "PipelineClient" + _config: RadiologyInsightsClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_version.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_version.py new file mode 100644 index 000000000000..be71c81bd282 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/__init__.py new file mode 100644 index 000000000000..3a05b0feea6f --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/__init__.py @@ -0,0 +1,23 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import RadiologyInsightsClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "RadiologyInsightsClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_client.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_client.py new file mode 100644 index 000000000000..20e5e0ec1799 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_client.py @@ -0,0 +1,102 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable + +from azure.core import AsyncPipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._serialization import Deserializer, Serializer +from ._configuration import RadiologyInsightsClientConfiguration +from ._operations import RadiologyInsightsClientOperationsMixin + + +class RadiologyInsightsClient( + RadiologyInsightsClientOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword + """RadiologyInsightsClient. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + _endpoint = "{endpoint}/health-insights" + self._config = RadiologyInsightsClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> "RadiologyInsightsClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_configuration.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_configuration.py new file mode 100644 index 000000000000..928142f56c33 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_configuration.py @@ -0,0 +1,62 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from .._version import VERSION + + +class RadiologyInsightsClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for RadiologyInsightsClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus2.api.cognitive.microsoft.com). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-09-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: AzureKeyCredential, **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-09-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + kwargs.setdefault("sdk_moniker", "healthinsights-radiologyinsights/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AzureKeyCredentialPolicy( + self.credential, "Ocp-Apim-Subscription-Key", **kwargs + ) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/__init__.py new file mode 100644 index 000000000000..24be3b0c64fc --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/__init__.py @@ -0,0 +1,19 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import RadiologyInsightsClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "RadiologyInsightsClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_operations.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_operations.py new file mode 100644 index 000000000000..6473f5face45 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_operations.py @@ -0,0 +1,2218 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod +from azure.core.polling.async_base_polling import AsyncLROBasePolling +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._model_base import SdkJSONEncoder, _deserialize +from ..._operations._operations import build_radiology_insights_infer_radiology_insights_request +from .._vendor import RadiologyInsightsClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class RadiologyInsightsClientOperationsMixin(RadiologyInsightsClientMixinABC): + async def _infer_radiology_insights_initial( + self, body: Union[_models.RadiologyInsightsData, JSON, IO[bytes]], **kwargs: Any + ) -> JSON: + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[JSON] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_radiology_insights_infer_radiology_insights_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(JSON, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_infer_radiology_insights( + self, body: _models.RadiologyInsightsData, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.RadiologyInsightsInferenceResult]: + # pylint: disable=line-too-long + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Required. + :type body: ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsData + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceOptions": { + "findingOptions": { + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide the sentence that contains the first token + of the finding's clinical indicator (i.e. the medical problem), if + there is one. This sentence is provided as an extension with url + 'ci_sentence', next to the token evidence. Default is false. + }, + "followupRecommendationOptions": { + "includeRecommendationsInReferences": bool, # + Optional. Include/Exclude follow-up recommendations in references to + a guideline or article. Default is false. + "includeRecommendationsWithNoSpecifiedModality": + bool, # Optional. Include/Exclude follow-up recommendations without + a specific radiology procedure. Default is false. + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide one or more sentences as evidence for the + recommendation, next to the token evidence. The start and end + positions of these sentences will be put in an extension with url + 'modality_sentences'. Default is false. + } + }, + "inferenceTypes": [ + "str" # Optional. This is a list of inference types to be + inferred for the current request. It could be used if only part of the + Radiology Insights inferences are required. If this list is omitted or + empty, the model will return all the inference types. + ], + "locale": "str", # Optional. Local for the model to use. If not + specified, the model will use the default locale. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + + @overload + async def begin_infer_radiology_insights( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.RadiologyInsightsInferenceResult]: + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + + @overload + async def begin_infer_radiology_insights( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.RadiologyInsightsInferenceResult]: + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + + @distributed_trace_async + async def begin_infer_radiology_insights( + self, body: Union[_models.RadiologyInsightsData, JSON, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.RadiologyInsightsInferenceResult]: + # pylint: disable=line-too-long + """Create Radiology Insights job. + + Creates a Radiology Insights job with the given request body. + + :param body: Is one of the following types: RadiologyInsightsData, JSON, IO[bytes] Required. + :type body: ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsData or JSON or + IO[bytes] + :return: An instance of AsyncLROPoller that returns RadiologyInsightsInferenceResult. The + RadiologyInsightsInferenceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "patients": [ + { + "id": "str", # A given identifier for the patient. Has to be + unique across all patients in a single request. Required. + "encounters": [ + { + "id": "str", # The id of the visit. + Required. + "class": "str", # Optional. The class of the + encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + "period": { + "end": "2020-02-20 00:00:00", # + Optional. End time with inclusive boundary, if not ongoing. + "start": "2020-02-20 00:00:00" # + Optional. Starting time with inclusive boundary. + } + } + ], + "info": { + "birthDate": "2020-02-20", # Optional. The patient's + date of birth. + "clinicalInfo": [ + { + "resourceType": "str", # The type of + resource. Required. + "id": "str", # Optional. Resource + Id. + "implicitRules": "str", # Optional. + A set of rules under which this content was created. + "language": "str", # Optional. + Language of the resource content. + "meta": { + "lastUpdated": "str", # + Optional. When the resource last changed - e.g. when the + version changed. + "profile": [ + "str" # Optional. A + list of profiles (references to `StructureDefinition + `_ + resources) that this resource claims to conform to. + The URL is a reference to `StructureDefinition.url + `_. + ], + "security": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "source": "str", # Optional. + A uri that identifies the source system of the resource. + This provides a minimal amount of Provenance information + that can be used to track or differentiate the source of + information in the resource. The source may identify + another FHIR server, document, message, database, etc. + "tag": [ + { + "code": + "str", # Optional. Symbol in syntax defined by + the system. + "display": + "str", # Optional. Representation defined by the + system. + "extension": + [ + { + "url": "str", # Source of the definition + for the extension code - a logical name + or a URL. Required. + "valueBoolean": bool, # Optional. Value + as boolean. + "valueCodeableConcept": { + "coding": [ + ... + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. + Value as dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time + with inclusive boundary, if not + ongoing. + "start": "str" # Optional. Starting + time with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier + value. + "type": { + "coding": [ + ... + ], + "text": "str" # Optional. + Plain text representation of + the concept. + }, + "use": "str", # Optional. usual + | official | temp | secondary | + old (If known). + "value": "str" # Optional. The + value that is unique. + }, + "reference": "str", # Optional. + Literal reference, Relative, internal + or absolute URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. + < | <= | >= | > - how to + understand the value. + "system": "str", # Optional. + System that defines coded unit + form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with implicit + precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | + "L". + "factor": 0.0, # Optional. Multiply + data by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value + as string. + "valueTime": "12:30:00" # Optional. + Value as time (hh:mm:ss). + } + ], + "id": "str", + # Optional. Unique id for inter-element + referencing. + "system": + "str", # Optional. Identity of the terminology + system. + "version": + "str" # Optional. Version of the system - if + relevant. + } + ], + "versionId": "str" # + Optional. The version specific identifier, as it appears + in the version portion of the URL. This value changes + when the resource is created, updated, or deleted. + } + } + ], + "sex": "str" # Optional. The patient's sex. Known + values are: "female", "male", and "unspecified". + }, + "patientDocuments": [ + { + "content": { + "sourceType": "str", # The type of + the content's source. In case the source type is 'inline', + the content is given as a string (for instance, text). In + case the source type is 'reference', the content is given as + a URI. Required. Known values are: "inline" and "reference". + "value": "str" # The content of the + document, given either inline (as a string) or as a reference + (URI). Required. + }, + "id": "str", # A given identifier for the + document. Has to be unique across all documents for a single + patient. Required. + "type": "str", # The type of the patient + document, such as 'note' (text document) or 'fhirBundle' (FHIR + JSON document). Required. Known values are: "note", "fhirBundle", + "dicom", and "genomicSequencing". + "administrativeMetadata": { + "encounterId": "str", # Optional. + Reference to the encounter associated with the document. + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "code": "str", # Optional. Symbol in + syntax defined by the system. + "display": "str", # Optional. + Representation defined by the system. + "extension": [ + { + "url": "str", # Source of the + definition for the extension code + - a logical name or a URL. + Required. + "valueBoolean": bool, # + Optional. Value as boolean. + "valueCodeableConcept": ..., + "valueDateTime": "str", # + Optional. Value as dateTime. + "valueInteger": 0, # Optional. + Value as integer. + "valuePeriod": { + "end": "str", # Optional. + End time with inclusive + boundary, if not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "valueQuantity": { + "code": "str", # Optional. + Coded form of the unit. + "comparator": "str", # + Optional. < | <= | >= | > - + how to understand the value. + "system": "str", # Optional. + System that defines coded + unit form. + "unit": "str", # Optional. + Unit representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "low": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "numerator": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + } + }, + "valueReference": { + "display": "str", # + Optional. Text alternative + for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # + Optional. End time + with inclusive + boundary, if not + ongoing. + "start": "str" # + Optional. Starting + time with inclusive + boundary. + }, + "system": "str", # + Optional. The namespace + for the identifier value. + "type": ..., + "use": "str", # + Optional. usual | + official | temp | + secondary | old (If + known). + "value": "str" # + Optional. The value that + is unique. + }, + "reference": "str", # + Optional. Literal reference, + Relative, internal or + absolute URL. + "type": "str" # Optional. + Type the reference refers to + (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of + sample points at each time + point. Required. + "origin": { + "code": "str", # + Optional. Coded form of + the unit. + "comparator": "str", # + Optional. < | <= | >= | > + - how to understand the + value. + "system": "str", # + Optional. System that + defines coded unit form. + "unit": "str", # + Optional. Unit + representation. + "value": 0.0 # Optional. + Numerical value (with + implicit precision). + }, + "period": 0.0, # Number of + milliseconds between samples. + Required. + "data": "str", # Optional. + Decimal values with spaces, + or "E" | "U" | "L". + "factor": 0.0, # Optional. + Multiply data by this before + adding to origin. + "lowerLimit": 0.0, # + Optional. Lower limit of + detection. + "upperLimit": 0.0 # + Optional. Upper limit of + detection. + }, + "valueString": "str", # + Optional. Value as string. + "valueTime": "12:30:00" # + Optional. Value as time + (hh:mm:ss). + } + ], + "id": "str", # Optional. Unique id for + inter-element referencing. + "system": "str", # Optional. Identity of + the terminology system. + "version": "str" # Optional. Version of + the system - if relevant. + } + ], + "text": "str" + # Optional. Plain text representation of the + concept. + }, + "description": "str", + # Optional. Procedure description. + "extension": [ + { + "url": "str", # Source of the definition for + the extension code - a logical name or a URL. + Required. + "valueBoolean": bool, # Optional. Value as + boolean. + "valueCodeableConcept": { + "coding": [ + { + "code": "str", # Optional. + Symbol in syntax defined by the + system. + "display": "str", # Optional. + Representation defined by the + system. + "extension": [ + ... + ], + "id": "str", # Optional. Unique + id for inter-element referencing. + "system": "str", # Optional. + Identity of the terminology + system. + "version": "str" # Optional. + Version of the system - if + relevant. + } + ], + "text": "str" # Optional. Plain text + representation of the concept. + }, + "valueDateTime": "str", # Optional. Value as + dateTime. + "valueInteger": 0, # Optional. Value as + integer. + "valuePeriod": { + "end": "str", # Optional. End time with + inclusive boundary, if not ongoing. + "start": "str" # Optional. Starting time + with inclusive boundary. + }, + "valueQuantity": { + "code": "str", # Optional. Coded form of + the unit. + "comparator": "str", # Optional. < | <= + | >= | > - how to understand the value. + "system": "str", # Optional. System that + defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical value + (with implicit precision). + }, + "valueRange": { + "high": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "low": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueRatio": { + "denominator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "numerator": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + } + }, + "valueReference": { + "display": "str", # Optional. Text + alternative for the resource. + "identifier": { + "assigner": ..., + "period": { + "end": "str", # Optional. End + time with inclusive boundary, if + not ongoing. + "start": "str" # Optional. + Starting time with inclusive + boundary. + }, + "system": "str", # Optional. The + namespace for the identifier value. + "type": { + "coding": [ + { + "code": "str", # + Optional. Symbol in + syntax defined by the + system. + "display": "str", # + Optional. Representation + defined by the system. + "extension": [ + ... + ], + "id": "str", # Optional. + Unique id for + inter-element + referencing. + "system": "str", # + Optional. Identity of the + terminology system. + "version": "str" # + Optional. Version of the + system - if relevant. + } + ], + "text": "str" # Optional. Plain + text representation of the + concept. + }, + "use": "str", # Optional. usual | + official | temp | secondary | old (If + known). + "value": "str" # Optional. The value + that is unique. + }, + "reference": "str", # Optional. Literal + reference, Relative, internal or absolute + URL. + "type": "str" # Optional. Type the + reference refers to (e.g. "Patient"). + }, + "valueSampledData": { + "dimensions": 0, # Number of sample + points at each time point. Required. + "origin": { + "code": "str", # Optional. Coded + form of the unit. + "comparator": "str", # Optional. < | + <= | >= | > - how to understand the + value. + "system": "str", # Optional. System + that defines coded unit form. + "unit": "str", # Optional. Unit + representation. + "value": 0.0 # Optional. Numerical + value (with implicit precision). + }, + "period": 0.0, # Number of milliseconds + between samples. Required. + "data": "str", # Optional. Decimal + values with spaces, or "E" | "U" | "L". + "factor": 0.0, # Optional. Multiply data + by this before adding to origin. + "lowerLimit": 0.0, # Optional. Lower + limit of detection. + "upperLimit": 0.0 # Optional. Upper + limit of detection. + }, + "valueString": "str", # Optional. Value as + string. + "valueTime": "12:30:00" # Optional. Value as + time (hh:mm:ss). + } + ] + } + ] + }, + "authors": [ + { + "fullName": "str", # + Optional. Text representation of the full name. + "id": "str" # Optional. + author id. + } + ], + "clinicalType": "str", # Optional. The type + of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", + "procedure", "progress", "laboratory", and "pathologyReport". + "createdDateTime": "2020-02-20 00:00:00", # + Optional. The date and time when the document was created. + "language": "str", # Optional. A 2 letter + ISO 639-1 representation of the language of the document. + "specialtyType": "str" # Optional. specialty + type the document. Known values are: "pathology" and "radiology". + } + ] + } + ], + "configuration": { + "includeEvidence": bool, # Optional. An indication whether the + model's output should include evidence for the inferences. + "inferenceOptions": { + "findingOptions": { + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide the sentence that contains the first token + of the finding's clinical indicator (i.e. the medical problem), if + there is one. This sentence is provided as an extension with url + 'ci_sentence', next to the token evidence. Default is false. + }, + "followupRecommendationOptions": { + "includeRecommendationsInReferences": bool, # + Optional. Include/Exclude follow-up recommendations in references to + a guideline or article. Default is false. + "includeRecommendationsWithNoSpecifiedModality": + bool, # Optional. Include/Exclude follow-up recommendations without + a specific radiology procedure. Default is false. + "provideFocusedSentenceEvidence": bool # Optional. + If this is true, provide one or more sentences as evidence for the + recommendation, next to the token evidence. The start and end + positions of these sentences will be put in an extension with url + 'modality_sentences'. Default is false. + } + }, + "inferenceTypes": [ + "str" # Optional. This is a list of inference types to be + inferred for the current request. It could be used if only part of the + Radiology Insights inferences are required. If this list is omitted or + empty, the model will return all the inference types. + ], + "locale": "str", # Optional. Local for the model to use. If not + specified, the model will use the default locale. + "verbose": bool # Optional. An indication whether the model should + produce verbose output. + } + } + + # response body for status code(s): 202 + response == { + "modelVersion": "str", # The version of the model used for inference, + expressed as the model date. Required. + "patientResults": [ + { + "inferences": [ + radiology_insights_inference + ], + "patientId": "str" # Identifier given for the patient in the + request. Required. + } + ] + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.RadiologyInsightsInferenceResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._infer_radiology_insights_initial( + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response_headers = {} + response = pipeline_response.http_response + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + + deserialized = _deserialize(_models.RadiologyInsightsInferenceResult, response.json().get("result")) + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + return deserialized + + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method: AsyncPollingMethod = cast( + AsyncPollingMethod, + AsyncLROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs), + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.RadiologyInsightsInferenceResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.RadiologyInsightsInferenceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_patch.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_patch.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_vendor.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_vendor.py new file mode 100644 index 000000000000..e2c3b938b89d --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/aio/_vendor.py @@ -0,0 +1,26 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import RadiologyInsightsClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import AsyncPipelineClient + + from .._serialization import Deserializer, Serializer + + +class RadiologyInsightsClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "AsyncPipelineClient" + _config: RadiologyInsightsClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/__init__.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/__init__.py new file mode 100644 index 000000000000..2a516ac12f5c --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/__init__.py @@ -0,0 +1,175 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import AgeMismatchInference +from ._models import Annotation +from ._models import CodeableConcept +from ._models import Coding +from ._models import CompleteOrderDiscrepancyInference +from ._models import Condition +from ._models import ConditionStage +from ._models import ContactDetail +from ._models import ContactPoint +from ._models import CriticalResult +from ._models import CriticalResultInference +from ._models import DocumentAdministrativeMetadata +from ._models import DocumentAuthor +from ._models import DocumentContent +from ._models import DomainResource +from ._models import Element +from ._models import Encounter +from ._models import Error +from ._models import Extension +from ._models import FindingInference +from ._models import FindingOptions +from ._models import FollowupCommunicationInference +from ._models import FollowupRecommendationInference +from ._models import FollowupRecommendationOptions +from ._models import GenericProcedureRecommendation +from ._models import HealthInsightsOperationStatus +from ._models import Identifier +from ._models import ImagingProcedure +from ._models import ImagingProcedureRecommendation +from ._models import InnerError +from ._models import LateralityDiscrepancyInference +from ._models import LimitedOrderDiscrepancyInference +from ._models import Meta +from ._models import Narrative +from ._models import Observation +from ._models import ObservationComponent +from ._models import ObservationReferenceRange +from ._models import OrderedProcedure +from ._models import PatientDetails +from ._models import PatientDocument +from ._models import PatientRecord +from ._models import Period +from ._models import ProcedureRecommendation +from ._models import Quantity +from ._models import RadiologyCodeWithTypes +from ._models import RadiologyInsightsData +from ._models import RadiologyInsightsInference +from ._models import RadiologyInsightsInferenceOptions +from ._models import RadiologyInsightsInferenceResult +from ._models import RadiologyInsightsModelConfiguration +from ._models import RadiologyInsightsPatientResult +from ._models import RadiologyProcedureInference +from ._models import Range +from ._models import Ratio +from ._models import RecommendationFinding +from ._models import Reference +from ._models import ResearchStudy +from ._models import ResearchStudyArm +from ._models import ResearchStudyObjective +from ._models import Resource +from ._models import SampledData +from ._models import SexMismatchInference +from ._models import TimePeriod + +from ._enums import ClinicalDocumentType +from ._enums import ContactPointSystem +from ._enums import ContactPointUse +from ._enums import DocumentContentSourceType +from ._enums import DocumentType +from ._enums import EncounterClass +from ._enums import JobStatus +from ._enums import LateralityDiscrepancyType +from ._enums import MedicalProfessionalType +from ._enums import ObservationStatusCodeType +from ._enums import PatientSex +from ._enums import RadiologyInsightsInferenceType +from ._enums import RecommendationFindingStatusType +from ._enums import RepeatabilityResult +from ._enums import ResearchStudyStatusCodeType +from ._enums import SpecialtyType +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "AgeMismatchInference", + "Annotation", + "CodeableConcept", + "Coding", + "CompleteOrderDiscrepancyInference", + "Condition", + "ConditionStage", + "ContactDetail", + "ContactPoint", + "CriticalResult", + "CriticalResultInference", + "DocumentAdministrativeMetadata", + "DocumentAuthor", + "DocumentContent", + "DomainResource", + "Element", + "Encounter", + "Error", + "Extension", + "FindingInference", + "FindingOptions", + "FollowupCommunicationInference", + "FollowupRecommendationInference", + "FollowupRecommendationOptions", + "GenericProcedureRecommendation", + "HealthInsightsOperationStatus", + "Identifier", + "ImagingProcedure", + "ImagingProcedureRecommendation", + "InnerError", + "LateralityDiscrepancyInference", + "LimitedOrderDiscrepancyInference", + "Meta", + "Narrative", + "Observation", + "ObservationComponent", + "ObservationReferenceRange", + "OrderedProcedure", + "PatientDetails", + "PatientDocument", + "PatientRecord", + "Period", + "ProcedureRecommendation", + "Quantity", + "RadiologyCodeWithTypes", + "RadiologyInsightsData", + "RadiologyInsightsInference", + "RadiologyInsightsInferenceOptions", + "RadiologyInsightsInferenceResult", + "RadiologyInsightsModelConfiguration", + "RadiologyInsightsPatientResult", + "RadiologyProcedureInference", + "Range", + "Ratio", + "RecommendationFinding", + "Reference", + "ResearchStudy", + "ResearchStudyArm", + "ResearchStudyObjective", + "Resource", + "SampledData", + "SexMismatchInference", + "TimePeriod", + "ClinicalDocumentType", + "ContactPointSystem", + "ContactPointUse", + "DocumentContentSourceType", + "DocumentType", + "EncounterClass", + "JobStatus", + "LateralityDiscrepancyType", + "MedicalProfessionalType", + "ObservationStatusCodeType", + "PatientSex", + "RadiologyInsightsInferenceType", + "RecommendationFindingStatusType", + "RepeatabilityResult", + "ResearchStudyStatusCodeType", + "SpecialtyType", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_enums.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_enums.py new file mode 100644 index 000000000000..b8c0850bdbd6 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_enums.py @@ -0,0 +1,278 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class ClinicalDocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the clinical document.""" + + CONSULTATION = "consultation" + DISCHARGE_SUMMARY = "dischargeSummary" + HISTORY_AND_PHYSICAL = "historyAndPhysical" + RADIOLOGY_REPORT = "radiologyReport" + PROCEDURE = "procedure" + PROGRESS = "progress" + LABORATORY = "laboratory" + PATHOLOGY_REPORT = "pathologyReport" + + +class ContactPointSystem(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Contact Point System + see https://www.hl7.org/fhir/R4/valueset-contact-point-system.html. + """ + + PHONE = "phone" + """Phone""" + FAX = "fax" + """Fax""" + EMAIL = "email" + """Email""" + PAGER = "pager" + """Pager""" + URL = "url" + """Url""" + SMS = "sms" + """Sms""" + OTHER = "other" + """Other""" + + +class ContactPointUse(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Contact Point Use + See: http://hl7.org/fhir/ValueSet/contact-point-use. + """ + + HOME = "home" + """Home""" + WORK = "work" + """Work""" + TEMP = "temp" + """Temp""" + OLD = "old" + """Old""" + MOBILE = "mobile" + """Mobile""" + + +class DocumentContentSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. + """ + + INLINE = "inline" + """The content is given as a string (for instance, text).""" + REFERENCE = "reference" + """The content is given as a URI.""" + + +class DocumentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON + document). + """ + + NOTE = "note" + FHIR_BUNDLE = "fhirBundle" + DICOM = "dicom" + GENOMIC_SEQUENCING = "genomicSequencing" + + +class EncounterClass(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR + value set--http://....). + """ + + IN_PATIENT = "inpatient" + """A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned + to a location where patients generally stay at least overnight and provided with room, board, + and continuous nursing service.""" + AMBULATORY = "ambulatory" + """The term ambulatory usually implies that the patient has come to the location and is not + assigned to a bed. Sometimes referred to as an outpatient encounter.""" + OBSERVATION = "observation" + """An encounter where the patient usually will start in different encounter, such as one in the + emergency department but then transition to this type of encounter because they require a + significant period of treatment and monitoring to determine whether or not their condition + warrants an inpatient admission or discharge.""" + EMERGENCY = "emergency" + """A patient encounter that takes place at a dedicated healthcare service delivery location where + the patient receives immediate evaluation and treatment, provided until the patient can be + discharged or responsibility for the patient's care is transferred elsewhere (for example, the + patient could be admitted as an inpatient or transferred to another facility.""" + VIRTUAL = "virtual" + """A patient encounter where the patient is not physically present for the encounter, such as in a + telehealth encounter, phone call, or electronic communication.""" + HEALTH_HOME = "healthHome" + """Healthcare encounter that takes place in the residence of the patient or a designee""" + + +class JobStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The status of the processing job.""" + + NOT_STARTED = "notStarted" + RUNNING = "running" + SUCCEEDED = "succeeded" + FAILED = "failed" + CANCELED = "canceled" + + +class LateralityDiscrepancyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Laterality discrepancy type.""" + + ORDER_LATERALITY_MISMATCH = "orderLateralityMismatch" + """Mismatch between order and text""" + TEXT_LATERALITY_CONTRADICTION = "textLateralityContradiction" + """Contradiction in text""" + TEXT_LATERALITY_MISSING = "textLateralityMissing" + """Missing laterality in text""" + + +class MedicalProfessionalType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Medical Professional Type.""" + + UNKNOWN = "unknown" + """Unknown medical professional type""" + DOCTOR = "doctor" + """Doctor medical professional type""" + NURSE = "nurse" + """Nurse medical professional type""" + MIDWIFE = "midwife" + """Technician medical professional type""" + PHYSICIAN_ASSISTANT = "physicianAssistant" + """Technician medical professional type""" + + +class ObservationStatusCodeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Observation Status + Based on `FHIR ObservationStatus + `_. + """ + + REGISTERED = "registered" + """The existence of the observation is registered, but there is no result yet available.""" + PRELIMINARY = "preliminary" + """This is an initial or interim observation: data may be incomplete or unverified.""" + FINAL = "final" + """The observation is complete and verified by an authorized person.""" + AMENDED = "amended" + """Subsequent to being Final, the observation has been modified subsequent. This includes + updates/new information and corrections.""" + CORRECTED = "corrected" + """Subsequent to being Final, the observation has been modified to correct an error in the test + result.""" + CANCELLED = "cancelled" + """The observation is unavailable because the measurement was not started or not completed (also + sometimes called "aborted").""" + ENTERED_IN_ERROR = "entered-in-error" + """The observation has been withdrawn following previous final release.""" + UNKNOWN = "unknown" + """The observation status is unknown. Note that "unknown" is a value of last resort and every + attempt should be made to provide a meaningful value other than "unknown".""" + + +class PatientSex(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The patient's sex.""" + + FEMALE = "female" + MALE = "male" + UNSPECIFIED = "unspecified" + + +class RadiologyInsightsInferenceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """A Radiology Insights inference types.""" + + AGE_MISMATCH = "ageMismatch" + """Age mismatch inference type""" + LATERALITY_DISCREPANCY = "lateralityDiscrepancy" + """Laterality discrepancy inference type""" + SEX_MISMATCH = "sexMismatch" + """Sex mismatch inference type""" + COMPLETE_ORDER_DISCREPANCY = "completeOrderDiscrepancy" + """Complete order discrepancy inference type""" + LIMITED_ORDER_DISCREPANCY = "limitedOrderDiscrepancy" + """Limited order discrepancy inference type""" + FINDING = "finding" + """Finding inference type""" + CRITICAL_RESULT = "criticalResult" + """Critical finding inference type""" + FOLLOWUP_RECOMMENDATION = "followupRecommendation" + """Recommendation inference type""" + FOLLOWUP_COMMUNICATION = "followupCommunication" + """Followup Communication inference type""" + RADIOLOGY_PROCEDURE = "radiologyProcedure" + """Radiology Procedure inference type""" + + +class RecommendationFindingStatusType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Recommendation finding status.""" + + PRESENT = "present" + """Present finding status""" + DIFFERENTIAL = "differential" + """Differential finding status""" + RULE_OUT = "ruleOut" + """Rule out finding status""" + CONDITIONAL = "conditional" + """Conditional finding status""" + + +class RepeatabilityResult(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Repeatability Result header options.""" + + ACCEPTED = "accepted" + """If the request was accepted and the server guarantees that the server state reflects a single + execution of the operation.""" + REJECTED = "rejected" + """If the request was rejected because the combination of Repeatability-First-Sent and + Repeatability-Request-ID were invalid + or because the Repeatability-First-Sent value was outside the range of values held by the + server.""" + + +class ResearchStudyStatusCodeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """https://www.hl7.org/fhir/R4/codesystem-research-study-status.html.""" + + ACTIVE = "active" + """The study is open for accrual.""" + ADMINISTRATIVELY_COMPLETED = "administratively-completed" + """Study is completed prematurely and will not resume; patients are no longer examined nor + treated.""" + APPROVED = "approved" + """Protocol is approved by the review board.""" + CLOSED_TO_ACCRUAL = "closed-to-accrual" + """Study is closed for accrual; patients can be examined and treated.""" + CLOSED_TO_ACCRUAL_AND_INTERVENTION = "closed-to-accrual-and-intervention" + """The study is closed to accrual and intervention, i.e. the study is closed to enrollment, all + study subjects have completed treatment or intervention but are still being followed according + to the primary objective of the study.""" + COMPLETED = "completed" + """Study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study + subjects have completed treatment or intervention but are still being followed according to the + primary objective of the study.""" + DISAPPROVED = "disapproved" + """Protocol was disapproved by the review board.""" + IN_REVIEW = "in-review" + """Protocol is submitted to the review board for approval.""" + TEMPORARILY_CLOSED_TO_ACCRUAL = "temporarily-closed-to-accrual" + """The study is temporarily closed to accrual; a pause in accrual while study is reviewed, but is + expected to resume.""" + TEMPORARILY_CLOSED_TO_ACCRUAL_AND_INTERVENTION = "temporarily-closed-to-accrual-and-intervention" + """Study is temporarily closed for accrual; can be potentially resumed in the future""" + WITHDRAWN = "withdrawn" + """Protocol was withdrawn by the lead organization.""" + + +class SpecialtyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Known values codes that can be used to indicate the type of the Specialty.""" + + PATHOLOGY = "pathology" + """pathology""" + RADIOLOGY = "radiology" + """radiology""" diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_models.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_models.py new file mode 100644 index 000000000000..c4908262937e --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_models.py @@ -0,0 +1,3509 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +import datetime +from typing import Any, Dict, List, Literal, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .. import _model_base +from .._model_base import rest_discriminator, rest_field +from ._enums import RadiologyInsightsInferenceType + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from .. import models as _models + + +class RadiologyInsightsInference(_model_base.Model): + """An inference made by the Radiology Insights model regarding a patient. + + + * AgeMismatch + * SexMismatch + * LateralityDiscrepancy + * CompleteOrderDiscrepancy + * LimitedOrderDiscrepancy + * Finding + * CriticalResult + * FollowupRecommendation + * RadiologyProcedure + * FollowupCommunication. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + AgeMismatchInference, CompleteOrderDiscrepancyInference, CriticalResultInference, + FindingInference, FollowupCommunicationInference, FollowupRecommendationInference, + LateralityDiscrepancyInference, LimitedOrderDiscrepancyInference, RadiologyProcedureInference, + SexMismatchInference + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Required. Known values are: "ageMismatch", "lateralityDiscrepancy", "sexMismatch", + "completeOrderDiscrepancy", "limitedOrderDiscrepancy", "finding", "criticalResult", + "followupRecommendation", "followupCommunication", and "radiologyProcedure". + :vartype kind: str or + ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceType + """ + + __mapping__: Dict[str, _model_base.Model] = {} + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + kind: str = rest_discriminator(name="kind") + """Required. Known values are: \"ageMismatch\", \"lateralityDiscrepancy\", \"sexMismatch\", + \"completeOrderDiscrepancy\", \"limitedOrderDiscrepancy\", \"finding\", \"criticalResult\", + \"followupRecommendation\", \"followupCommunication\", and \"radiologyProcedure\".""" + + @overload + def __init__( + self, + *, + kind: str, + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AgeMismatchInference(RadiologyInsightsInference, discriminator="ageMismatch"): + """A notification for age mismatch is displayed when the age mentioned in a document for a + specific patient does not match the age specified in the patient information. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Age mismatch inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.AGE_MISMATCH + """ + + kind: Literal[RadiologyInsightsInferenceType.AGE_MISMATCH] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Age mismatch inference type""" + + @overload + def __init__( + self, + *, + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RadiologyInsightsInferenceType.AGE_MISMATCH, **kwargs) + + +class Element(_model_base.Model): + """The base definition for all elements contained inside a resource. + Based on `FHIR Element `_. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + """ + + id: Optional[str] = rest_field() + """Unique id for inter-element referencing.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Annotation(Element): + """A text note which also contains information about who made the statement and when + Based on `FHIR Annotation `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar author_string: Individual responsible for the annotation. + :vartype author_string: str + :ivar time: When the annotation was made. + :vartype time: str + :ivar text: The annotation - text content (as markdown). Required. + :vartype text: str + """ + + author_string: Optional[str] = rest_field(name="authorString") + """Individual responsible for the annotation.""" + time: Optional[str] = rest_field() + """When the annotation was made.""" + text: str = rest_field() + """The annotation - text content (as markdown). Required.""" + + @overload + def __init__( + self, + *, + text: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + author_string: Optional[str] = None, + time: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CodeableConcept(Element): + """Concept - reference to a terminology or just text + Based on `FHIR CodeableConcept `_. + + :ivar coding: Code defined by a terminology system. + :vartype coding: list[~azure.healthinsights.radiologyinsights.models.Coding] + :ivar text: Plain text representation of the concept. + :vartype text: str + """ + + coding: Optional[List["_models.Coding"]] = rest_field() + """Code defined by a terminology system.""" + text: Optional[str] = rest_field() + """Plain text representation of the concept.""" + + @overload + def __init__( + self, + *, + coding: Optional[List["_models.Coding"]] = None, + text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Coding(Element): + """A Coding is a representation of a defined concept using a symbol from a defined "code system". + Based on `FHIR Coding `_. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar system: Identity of the terminology system. + :vartype system: str + :ivar version: Version of the system - if relevant. + :vartype version: str + :ivar code: Symbol in syntax defined by the system. + :vartype code: str + :ivar display: Representation defined by the system. + :vartype display: str + """ + + system: Optional[str] = rest_field() + """Identity of the terminology system.""" + version: Optional[str] = rest_field() + """Version of the system - if relevant.""" + code: Optional[str] = rest_field() + """Symbol in syntax defined by the system.""" + display: Optional[str] = rest_field() + """Representation defined by the system.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + system: Optional[str] = None, + version: Optional[str] = None, + code: Optional[str] = None, + display: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CompleteOrderDiscrepancyInference(RadiologyInsightsInference, discriminator="completeOrderDiscrepancy"): + """A complete order discrepancy is shown when one or more body parts and/or measurements that + should be in the document (because there is a complete order) are not present. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Complete order discrepancy inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.COMPLETE_ORDER_DISCREPANCY + :ivar order_type: Order type : CPT ultrasound complete code for abdomen, retroperitoneal, + pelvis or breast. Required. + :vartype order_type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar missing_body_parts: List of missing body parts required by a complete order : SNOMED CT + codes. + :vartype missing_body_parts: + list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar missing_body_part_measurements: List of missing body parts that require measurement by a + complete order : SNOMED CT codes. + :vartype missing_body_part_measurements: + list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + """ + + kind: Literal[RadiologyInsightsInferenceType.COMPLETE_ORDER_DISCREPANCY] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Complete order discrepancy inference type""" + order_type: "_models.CodeableConcept" = rest_field(name="orderType") + """Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast. + Required.""" + missing_body_parts: Optional[List["_models.CodeableConcept"]] = rest_field(name="missingBodyParts") + """List of missing body parts required by a complete order : SNOMED CT codes.""" + missing_body_part_measurements: Optional[List["_models.CodeableConcept"]] = rest_field( + name="missingBodyPartMeasurements" + ) + """List of missing body parts that require measurement by a complete order : SNOMED CT codes.""" + + @overload + def __init__( + self, + *, + order_type: "_models.CodeableConcept", + extension: Optional[List["_models.Extension"]] = None, + missing_body_parts: Optional[List["_models.CodeableConcept"]] = None, + missing_body_part_measurements: Optional[List["_models.CodeableConcept"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RadiologyInsightsInferenceType.COMPLETE_ORDER_DISCREPANCY, **kwargs) + + +class Resource(_model_base.Model): + """Resource is the ancestor of DomainResource from which most resources are derived. Bundle, + Parameters, and Binary extend Resource directly. + Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html. + + All required parameters must be populated in order to send to server. + + :ivar resource_type: The type of resource. Required. + :vartype resource_type: str + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.radiologyinsights.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + """ + + resource_type: str = rest_field(name="resourceType") + """The type of resource. Required.""" + id: Optional[str] = rest_field() + """Resource Id.""" + meta: Optional["_models.Meta"] = rest_field() + """Metadata about the resource.""" + implicit_rules: Optional[str] = rest_field(name="implicitRules") + """A set of rules under which this content was created.""" + language: Optional[str] = rest_field() + """Language of the resource content.""" + + @overload + def __init__( + self, + *, + resource_type: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DomainResource(Resource): + """A resource with narrative, extensions, and contained resources + Based on `FHIR DomainResource `_. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + Condition, ResearchStudy + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.radiologyinsights.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.radiologyinsights.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.radiologyinsights.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar resource_type: Required. Default value is None. + :vartype resource_type: str + """ + + __mapping__: Dict[str, _model_base.Model] = {} + text: Optional["_models.Narrative"] = rest_field() + """Text summary of the resource, for human interpretation.""" + contained: Optional[List["_models.Resource"]] = rest_field() + """Contained, inline Resources.""" + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + modifier_extension: Optional[List["_models.Extension"]] = rest_field(name="modifierExtension") + """Extensions that cannot be ignored.""" + resource_type: str = rest_discriminator(name="resourceType") + """Required. Default value is None.""" + + @overload + def __init__( + self, + *, + resource_type: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Condition(DomainResource, discriminator="Condition"): # pylint: disable=too-many-instance-attributes + """Detailed information about conditions, problems or diagnoses + Based on `FHIR Condition `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.radiologyinsights.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.radiologyinsights.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.radiologyinsights.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "Condition". + :vartype resource_type: str + :ivar identifier: External Ids for this condition. + :vartype identifier: list[~azure.healthinsights.radiologyinsights.models.Identifier] + :ivar clinical_status: active | recurrence | relapse | inactive | remission | resolved. + :vartype clinical_status: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar verification_status: unconfirmed | provisional | differential | confirmed | refuted | + entered-in-error. + :vartype verification_status: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar category: problem-list-item | encounter-diagnosis. + :vartype category: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar severity: Subjective severity of condition. + :vartype severity: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar code: Identification of the condition, problem or diagnosis. + :vartype code: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar body_site: Anatomical location, if relevant. + :vartype body_site: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar encounter: Encounter created as part of. + :vartype encounter: ~azure.healthinsights.radiologyinsights.models.Reference + :ivar onset_date_time: Estimated or actual date, date-time, or age. + :vartype onset_date_time: str + :ivar onset_age: Estimated or actual date, date-time, or age. + :vartype onset_age: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar onset_period: Estimated or actual date, date-time, or age. + :vartype onset_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar onset_range: Estimated or actual date, date-time, or age. + :vartype onset_range: ~azure.healthinsights.radiologyinsights.models.Range + :ivar onset_string: Estimated or actual date, date-time, or age. + :vartype onset_string: str + :ivar abatement_date_time: When in resolution/remission. + :vartype abatement_date_time: str + :ivar abatement_age: When in resolution/remission. + :vartype abatement_age: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar abatement_period: When in resolution/remission. + :vartype abatement_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar abatement_range: When in resolution/remission. + :vartype abatement_range: ~azure.healthinsights.radiologyinsights.models.Range + :ivar abatement_string: When in resolution/remission. + :vartype abatement_string: str + :ivar recorded_date: Date record was first recorded. + :vartype recorded_date: str + :ivar stage: stge/grade, usually assessed formally. + :vartype stage: list[~azure.healthinsights.radiologyinsights.models.ConditionStage] + :ivar note: Additional information about the Condition. + :vartype note: list[~azure.healthinsights.radiologyinsights.models.Annotation] + """ + + resource_type: Literal["Condition"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"Condition\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """External Ids for this condition.""" + clinical_status: Optional["_models.CodeableConcept"] = rest_field(name="clinicalStatus") + """active | recurrence | relapse | inactive | remission | resolved.""" + verification_status: Optional["_models.CodeableConcept"] = rest_field(name="verificationStatus") + """unconfirmed | provisional | differential | confirmed | refuted | entered-in-error.""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """problem-list-item | encounter-diagnosis.""" + severity: Optional["_models.CodeableConcept"] = rest_field() + """Subjective severity of condition.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Identification of the condition, problem or diagnosis.""" + body_site: Optional[List["_models.CodeableConcept"]] = rest_field(name="bodySite") + """Anatomical location, if relevant.""" + encounter: Optional["_models.Reference"] = rest_field() + """Encounter created as part of.""" + onset_date_time: Optional[str] = rest_field(name="onsetDateTime") + """Estimated or actual date, date-time, or age.""" + onset_age: Optional["_models.Quantity"] = rest_field(name="onsetAge") + """Estimated or actual date, date-time, or age.""" + onset_period: Optional["_models.Period"] = rest_field(name="onsetPeriod") + """Estimated or actual date, date-time, or age.""" + onset_range: Optional["_models.Range"] = rest_field(name="onsetRange") + """Estimated or actual date, date-time, or age.""" + onset_string: Optional[str] = rest_field(name="onsetString") + """Estimated or actual date, date-time, or age.""" + abatement_date_time: Optional[str] = rest_field(name="abatementDateTime") + """When in resolution/remission.""" + abatement_age: Optional["_models.Quantity"] = rest_field(name="abatementAge") + """When in resolution/remission.""" + abatement_period: Optional["_models.Period"] = rest_field(name="abatementPeriod") + """When in resolution/remission.""" + abatement_range: Optional["_models.Range"] = rest_field(name="abatementRange") + """When in resolution/remission.""" + abatement_string: Optional[str] = rest_field(name="abatementString") + """When in resolution/remission.""" + recorded_date: Optional[str] = rest_field(name="recordedDate") + """Date record was first recorded.""" + stage: Optional[List["_models.ConditionStage"]] = rest_field() + """stge/grade, usually assessed formally.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Additional information about the Condition.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + clinical_status: Optional["_models.CodeableConcept"] = None, + verification_status: Optional["_models.CodeableConcept"] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + severity: Optional["_models.CodeableConcept"] = None, + code: Optional["_models.CodeableConcept"] = None, + body_site: Optional[List["_models.CodeableConcept"]] = None, + encounter: Optional["_models.Reference"] = None, + onset_date_time: Optional[str] = None, + onset_age: Optional["_models.Quantity"] = None, + onset_period: Optional["_models.Period"] = None, + onset_range: Optional["_models.Range"] = None, + onset_string: Optional[str] = None, + abatement_date_time: Optional[str] = None, + abatement_age: Optional["_models.Quantity"] = None, + abatement_period: Optional["_models.Period"] = None, + abatement_range: Optional["_models.Range"] = None, + abatement_string: Optional[str] = None, + recorded_date: Optional[str] = None, + stage: Optional[List["_models.ConditionStage"]] = None, + note: Optional[List["_models.Annotation"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, resource_type="Condition", **kwargs) + + +class ConditionStage(_model_base.Model): + """Stage/grade, usually assessed formally + Based on `FHIR Condition.Stage `_. + + :ivar summary: Simple summary (disease specific). + :vartype summary: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar type: Kind of staging. + :vartype type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + """ + + summary: Optional["_models.CodeableConcept"] = rest_field() + """Simple summary (disease specific).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Kind of staging.""" + + @overload + def __init__( + self, + *, + summary: Optional["_models.CodeableConcept"] = None, + type: Optional["_models.CodeableConcept"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ContactDetail(Element): + """Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail). + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar name: Name of an individual to contact. + :vartype name: str + :ivar telecom: Contact details for individual or organization. + :vartype telecom: list[~azure.healthinsights.radiologyinsights.models.ContactPoint] + """ + + name: Optional[str] = rest_field() + """Name of an individual to contact.""" + telecom: Optional[List["_models.ContactPoint"]] = rest_field() + """Contact details for individual or organization.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + name: Optional[str] = None, + telecom: Optional[List["_models.ContactPoint"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ContactPoint(_model_base.Model): + """Details for all kinds of technology mediated contact points for a person or organization, + including telephone, email, etc. + See https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint. + + :ivar system: phone | fax | email | pager | url | sms | other. Known values are: "phone", + "fax", "email", "pager", "url", "sms", and "other". + :vartype system: str or ~azure.healthinsights.radiologyinsights.models.ContactPointSystem + :ivar value: The actual contact point details. + :vartype value: str + :ivar use: home | work | temp | old | mobile - purpose of this contact point. Known values are: + "home", "work", "temp", "old", and "mobile". + :vartype use: str or ~azure.healthinsights.radiologyinsights.models.ContactPointUse + :ivar rank: Specify preferred order of use (1 = highest). + :vartype rank: int + :ivar period: Time period when the contact point was/is in use. + :vartype period: ~azure.healthinsights.radiologyinsights.models.Period + """ + + system: Optional[Union[str, "_models.ContactPointSystem"]] = rest_field() + """phone | fax | email | pager | url | sms | other. Known values are: \"phone\", \"fax\", + \"email\", \"pager\", \"url\", \"sms\", and \"other\".""" + value: Optional[str] = rest_field() + """The actual contact point details.""" + use: Optional[Union[str, "_models.ContactPointUse"]] = rest_field() + """home | work | temp | old | mobile - purpose of this contact point. Known values are: \"home\", + \"work\", \"temp\", \"old\", and \"mobile\".""" + rank: Optional[int] = rest_field() + """Specify preferred order of use (1 = highest).""" + period: Optional["_models.Period"] = rest_field() + """Time period when the contact point was/is in use.""" + + @overload + def __init__( + self, + *, + system: Optional[Union[str, "_models.ContactPointSystem"]] = None, + value: Optional[str] = None, + use: Optional[Union[str, "_models.ContactPointUse"]] = None, + rank: Optional[int] = None, + period: Optional["_models.Period"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CriticalResult(_model_base.Model): + """Critical Result consists of two properties. + + All required parameters must be populated in order to send to server. + + :ivar description: Description : medical problem. Required. + :vartype description: str + :ivar finding: Finding linked to the critical result. + :vartype finding: ~azure.healthinsights.radiologyinsights.models.Observation + """ + + description: str = rest_field() + """Description : medical problem. Required.""" + finding: Optional["_models.Observation"] = rest_field() + """Finding linked to the critical result.""" + + @overload + def __init__( + self, + *, + description: str, + finding: Optional["_models.Observation"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CriticalResultInference(RadiologyInsightsInference, discriminator="criticalResult"): + """Critical results refer to findings of utmost importance that may require timely attention due + to their potential impact on patient care. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Critical finding inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.CRITICAL_RESULT + :ivar result: The complete Critical Result, as outlined below, will be reused for the + recommendation. Required. + :vartype result: ~azure.healthinsights.radiologyinsights.models.CriticalResult + """ + + kind: Literal[RadiologyInsightsInferenceType.CRITICAL_RESULT] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Critical finding inference type""" + result: "_models.CriticalResult" = rest_field() + """The complete Critical Result, as outlined below, will be reused for the recommendation. + Required.""" + + @overload + def __init__( + self, + *, + result: "_models.CriticalResult", + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RadiologyInsightsInferenceType.CRITICAL_RESULT, **kwargs) + + +class DocumentAdministrativeMetadata(_model_base.Model): + """Document administrative metadata. + + :ivar ordered_procedures: List of procedure information associated with the document. + :vartype ordered_procedures: + list[~azure.healthinsights.radiologyinsights.models.OrderedProcedure] + :ivar encounter_id: Reference to the encounter associated with the document. + :vartype encounter_id: str + """ + + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = rest_field(name="orderedProcedures") + """List of procedure information associated with the document.""" + encounter_id: Optional[str] = rest_field(name="encounterId") + """Reference to the encounter associated with the document.""" + + @overload + def __init__( + self, + *, + ordered_procedures: Optional[List["_models.OrderedProcedure"]] = None, + encounter_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentAuthor(_model_base.Model): + """Document author. + + :ivar id: author id. + :vartype id: str + :ivar full_name: Text representation of the full name. + :vartype full_name: str + """ + + id: Optional[str] = rest_field() + """author id.""" + full_name: Optional[str] = rest_field(name="fullName") + """Text representation of the full name.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + full_name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DocumentContent(_model_base.Model): + """The content of the patient document. + + All required parameters must be populated in order to send to server. + + :ivar source_type: The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: "inline" and "reference". + :vartype source_type: str or + ~azure.healthinsights.radiologyinsights.models.DocumentContentSourceType + :ivar value: The content of the document, given either inline (as a string) or as a reference + (URI). Required. + :vartype value: str + """ + + source_type: Union[str, "_models.DocumentContentSourceType"] = rest_field(name="sourceType") + """The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. Required. Known values + are: \"inline\" and \"reference\".""" + value: str = rest_field() + """The content of the document, given either inline (as a string) or as a reference (URI). + Required.""" + + @overload + def __init__( + self, + *, + source_type: Union[str, "_models.DocumentContentSourceType"], + value: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Encounter(_model_base.Model): + """visit/encounter information. + + All required parameters must be populated in order to send to server. + + :ivar id: The id of the visit. Required. + :vartype id: str + :ivar period: Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end + to indicate the discharge time. + :vartype period: ~azure.healthinsights.radiologyinsights.models.TimePeriod + :ivar class_property: The class of the encounter. Known values are: "inpatient", "ambulatory", + "observation", "emergency", "virtual", and "healthHome". + :vartype class_property: str or ~azure.healthinsights.radiologyinsights.models.EncounterClass + """ + + id: str = rest_field() + """The id of the visit. Required.""" + period: Optional["_models.TimePeriod"] = rest_field() + """Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to + indicate the discharge time.""" + class_property: Optional[Union[str, "_models.EncounterClass"]] = rest_field(name="class") + """The class of the encounter. Known values are: \"inpatient\", \"ambulatory\", \"observation\", + \"emergency\", \"virtual\", and \"healthHome\".""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + period: Optional["_models.TimePeriod"] = None, + class_property: Optional[Union[str, "_models.EncounterClass"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Error(_model_base.Model): + """The error object. + + All required parameters must be populated in order to send to server. + + :ivar code: One of a server-defined set of error codes. Required. + :vartype code: str + :ivar message: A human-readable representation of the error. Required. + :vartype message: str + :ivar target: The target of the error. + :vartype target: str + :ivar details: An array of details about specific errors that led to this reported error. + :vartype details: list[~azure.healthinsights.radiologyinsights.models.Error] + :ivar innererror: An object containing more specific information than the current object about + the error. + :vartype innererror: ~azure.healthinsights.radiologyinsights.models.InnerError + """ + + code: str = rest_field() + """One of a server-defined set of error codes. Required.""" + message: str = rest_field() + """A human-readable representation of the error. Required.""" + target: Optional[str] = rest_field() + """The target of the error.""" + details: Optional[List["_models.Error"]] = rest_field() + """An array of details about specific errors that led to this reported error.""" + innererror: Optional["_models.InnerError"] = rest_field() + """An object containing more specific information than the current object about the error.""" + + @overload + def __init__( + self, + *, + code: str, + message: str, + target: Optional[str] = None, + details: Optional[List["_models.Error"]] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Extension(Element): # pylint: disable=too-many-instance-attributes + """Base for all elements + Based on `FHIR Element `_. + + All required parameters must be populated in order to send to server. + + :ivar url: Source of the definition for the extension code - a logical name or a URL. Required. + :vartype url: str + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.radiologyinsights.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.radiologyinsights.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.radiologyinsights.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.radiologyinsights.models.Reference + """ + + url: str = rest_field() + """Source of the definition for the extension code - a logical name or a URL. Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + + @overload + def __init__( + self, + *, + url: str, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class FindingInference(RadiologyInsightsInference, discriminator="finding"): + """Findings in a radiology report typically describe abnormalities, lesions, or other notable + observations related to the anatomy or pathology of the imaged area. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Finding inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.FINDING + :ivar finding: Finding data : contains extensions, fields and components linked with the + finding. Required. + :vartype finding: ~azure.healthinsights.radiologyinsights.models.Observation + """ + + kind: Literal[RadiologyInsightsInferenceType.FINDING] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Finding inference type""" + finding: "_models.Observation" = rest_field() + """Finding data : contains extensions, fields and components linked with the finding. Required.""" + + @overload + def __init__( + self, + *, + finding: "_models.Observation", + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RadiologyInsightsInferenceType.FINDING, **kwargs) + + +class FindingOptions(_model_base.Model): + """Finding options. + + :ivar provide_focused_sentence_evidence: If this is true, provide the sentence that contains + the first token of the finding's clinical indicator (i.e. the medical problem), if there is + one. This sentence is provided as an extension with url 'ci_sentence', next to the token + evidence. Default is false. + :vartype provide_focused_sentence_evidence: bool + """ + + provide_focused_sentence_evidence: Optional[bool] = rest_field(name="provideFocusedSentenceEvidence") + """If this is true, provide the sentence that contains the first token of the finding's clinical + indicator (i.e. the medical problem), if there is one. This sentence is provided as an + extension with url 'ci_sentence', next to the token evidence. Default is false.""" + + @overload + def __init__( + self, + *, + provide_focused_sentence_evidence: Optional[bool] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class FollowupCommunicationInference(RadiologyInsightsInference, discriminator="followupCommunication"): + """Follow-up communication involves the exchange of important information, recommendations, or + updates between radiologists and other healthcare professionals involved in a patient's care. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Followup Communication inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.FOLLOWUP_COMMUNICATION + :ivar date_time: Communication date and time. + :vartype date_time: list[~datetime.datetime] + :ivar recipient: Recipient of the communication. + :vartype recipient: list[str or + ~azure.healthinsights.radiologyinsights.models.MedicalProfessionalType] + :ivar was_acknowledged: Communication was acknowledged. Required. + :vartype was_acknowledged: bool + """ + + kind: Literal[RadiologyInsightsInferenceType.FOLLOWUP_COMMUNICATION] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Followup Communication inference type""" + date_time: Optional[List[datetime.datetime]] = rest_field(name="dateTime", format="rfc3339") + """Communication date and time.""" + recipient: Optional[List[Union[str, "_models.MedicalProfessionalType"]]] = rest_field() + """Recipient of the communication.""" + was_acknowledged: bool = rest_field(name="wasAcknowledged") + """Communication was acknowledged. Required.""" + + @overload + def __init__( + self, + *, + was_acknowledged: bool, + extension: Optional[List["_models.Extension"]] = None, + date_time: Optional[List[datetime.datetime]] = None, + recipient: Optional[List[Union[str, "_models.MedicalProfessionalType"]]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RadiologyInsightsInferenceType.FOLLOWUP_COMMUNICATION, **kwargs) + + +class FollowupRecommendationInference(RadiologyInsightsInference, discriminator="followupRecommendation"): + """Follow-up recommendations offer guidance to healthcare providers on managing and monitoring + patients based on the findings of imaging studies. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Recommendation inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.FOLLOWUP_RECOMMENDATION + :ivar effective_date_time: Date and time are displayed when the procedure is recommended to be + done at a specific point in time. + :vartype effective_date_time: str + :ivar effective_period: The period is shown if a specific period is mentioned, with a start and + end date-time. + :vartype effective_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar findings: Findings related to the recommendation. + :vartype findings: list[~azure.healthinsights.radiologyinsights.models.RecommendationFinding] + :ivar is_conditional: The conditional value indicates whether or not the sentence containing + the recommendation includes a conditional statement. Keywords for conditional statements + include 'if', 'when', 'unless', and so on. Required. + :vartype is_conditional: bool + :ivar is_option: The option value indicates whether or not the sentence containing the + recommendation includes an optional statement. Keywords for optional statements include + 'recommend', 'consider', and so on. Required. + :vartype is_option: bool + :ivar is_guideline: The guideline value indicates whether or not the recommendation is part of + a guideline section that compiles all recommendations applicable to various findings. Required. + :vartype is_guideline: bool + :ivar is_hedging: Hedging refers to ambiguous, vague or imprecise language within the sentence + of the recommendation. Keywords for hedging are 'can be','may be',and so on. Required. + :vartype is_hedging: bool + :ivar recommended_procedure: The procedure recommendation can be a generic procedure or an + imaging procedure. Required. + :vartype recommended_procedure: + ~azure.healthinsights.radiologyinsights.models.ProcedureRecommendation + """ + + kind: Literal[RadiologyInsightsInferenceType.FOLLOWUP_RECOMMENDATION] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Recommendation inference type""" + effective_date_time: Optional[str] = rest_field(name="effectiveDateTime") + """Date and time are displayed when the procedure is recommended to be done at a specific point in + time.""" + effective_period: Optional["_models.Period"] = rest_field(name="effectivePeriod") + """The period is shown if a specific period is mentioned, with a start and end date-time.""" + findings: Optional[List["_models.RecommendationFinding"]] = rest_field() + """Findings related to the recommendation.""" + is_conditional: bool = rest_field(name="isConditional") + """The conditional value indicates whether or not the sentence containing the recommendation + includes a conditional statement. Keywords for conditional statements include 'if', 'when', + 'unless', and so on. Required.""" + is_option: bool = rest_field(name="isOption") + """The option value indicates whether or not the sentence containing the recommendation includes + an optional statement. Keywords for optional statements include 'recommend', 'consider', and so + on. Required.""" + is_guideline: bool = rest_field(name="isGuideline") + """The guideline value indicates whether or not the recommendation is part of a guideline section + that compiles all recommendations applicable to various findings. Required.""" + is_hedging: bool = rest_field(name="isHedging") + """Hedging refers to ambiguous, vague or imprecise language within the sentence of the + recommendation. Keywords for hedging are 'can be','may be',and so on. Required.""" + recommended_procedure: "_models.ProcedureRecommendation" = rest_field(name="recommendedProcedure") + """The procedure recommendation can be a generic procedure or an imaging procedure. Required.""" + + @overload + def __init__( + self, + *, + is_conditional: bool, + is_option: bool, + is_guideline: bool, + is_hedging: bool, + recommended_procedure: "_models.ProcedureRecommendation", + extension: Optional[List["_models.Extension"]] = None, + effective_date_time: Optional[str] = None, + effective_period: Optional["_models.Period"] = None, + findings: Optional[List["_models.RecommendationFinding"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RadiologyInsightsInferenceType.FOLLOWUP_RECOMMENDATION, **kwargs) + + +class FollowupRecommendationOptions(_model_base.Model): + """Follow-up recommendation options. + + :ivar include_recommendations_with_no_specified_modality: Include/Exclude follow-up + recommendations without a specific radiology procedure. Default is false. + :vartype include_recommendations_with_no_specified_modality: bool + :ivar include_recommendations_in_references: Include/Exclude follow-up recommendations in + references to a guideline or article. Default is false. + :vartype include_recommendations_in_references: bool + :ivar provide_focused_sentence_evidence: If this is true, provide one or more sentences as + evidence for the recommendation, next to the token evidence. The start and end positions of + these sentences will be put in an extension with url 'modality_sentences'. Default is false. + :vartype provide_focused_sentence_evidence: bool + """ + + include_recommendations_with_no_specified_modality: Optional[bool] = rest_field( + name="includeRecommendationsWithNoSpecifiedModality" + ) + """Include/Exclude follow-up recommendations without a specific radiology procedure. Default is + false.""" + include_recommendations_in_references: Optional[bool] = rest_field(name="includeRecommendationsInReferences") + """Include/Exclude follow-up recommendations in references to a guideline or article. Default is + false.""" + provide_focused_sentence_evidence: Optional[bool] = rest_field(name="provideFocusedSentenceEvidence") + """If this is true, provide one or more sentences as evidence for the recommendation, next to the + token evidence. The start and end positions of these sentences will be put in an extension with + url 'modality_sentences'. Default is false.""" + + @overload + def __init__( + self, + *, + include_recommendations_with_no_specified_modality: Optional[bool] = None, + include_recommendations_in_references: Optional[bool] = None, + provide_focused_sentence_evidence: Optional[bool] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ProcedureRecommendation(_model_base.Model): + """The procedure recommendation can be a generic procedure or an imaging procedure. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + GenericProcedureRecommendation, ImagingProcedureRecommendation + + All required parameters must be populated in order to send to server. + + :ivar kind: Required. Default value is None. + :vartype kind: str + """ + + __mapping__: Dict[str, _model_base.Model] = {} + kind: str = rest_discriminator(name="kind") + """Required. Default value is None.""" + + @overload + def __init__( + self, + *, + kind: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class GenericProcedureRecommendation(ProcedureRecommendation, discriminator="genericProcedureRecommendation"): + """Generic procedure information. + + All required parameters must be populated in order to send to server. + + :ivar kind: Procedure type : generic. Required. Default value is + "genericProcedureRecommendation". + :vartype kind: str + :ivar code: Procedure modality : SNOMED CT code. Required. + :vartype code: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar description: Procedure description : MANAGEMENT PROCEDURE (PROCEDURE) or CONSULTATION + (PROCEDURE) based on SNOMED CT. + :vartype description: str + """ + + kind: Literal["genericProcedureRecommendation"] = rest_discriminator(name="kind") # type: ignore + """Procedure type : generic. Required. Default value is \"genericProcedureRecommendation\".""" + code: "_models.CodeableConcept" = rest_field() + """Procedure modality : SNOMED CT code. Required.""" + description: Optional[str] = rest_field() + """Procedure description : MANAGEMENT PROCEDURE (PROCEDURE) or CONSULTATION (PROCEDURE) based on + SNOMED CT.""" + + @overload + def __init__( + self, + *, + code: "_models.CodeableConcept", + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind="genericProcedureRecommendation", **kwargs) + + +class HealthInsightsOperationStatus(_model_base.Model): + """Provides status details for long running operations. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: The unique ID of the operation. Required. + :vartype id: str + :ivar status: The status of the operation. Required. Known values are: "notStarted", "running", + "succeeded", "failed", and "canceled". + :vartype status: str or ~azure.healthinsights.radiologyinsights.models.JobStatus + :ivar created_date_time: The date and time when the processing job was created. + :vartype created_date_time: ~datetime.datetime + :ivar expiration_date_time: The date and time when the processing job is set to expire. + :vartype expiration_date_time: ~datetime.datetime + :ivar last_update_date_time: The date and time when the processing job was last updated. + :vartype last_update_date_time: ~datetime.datetime + :ivar error: Error object that describes the error when status is "Failed". + :vartype error: ~azure.healthinsights.radiologyinsights.models.Error + :ivar result: The result of the operation. + :vartype result: + ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceResult + """ + + id: str = rest_field(visibility=["read"]) + """The unique ID of the operation. Required.""" + status: Union[str, "_models.JobStatus"] = rest_field(visibility=["read"]) + """The status of the operation. Required. Known values are: \"notStarted\", \"running\", + \"succeeded\", \"failed\", and \"canceled\".""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was created.""" + expiration_date_time: Optional[datetime.datetime] = rest_field( + name="expirationDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job is set to expire.""" + last_update_date_time: Optional[datetime.datetime] = rest_field( + name="lastUpdateDateTime", visibility=["read"], format="rfc3339" + ) + """The date and time when the processing job was last updated.""" + error: Optional["_models.Error"] = rest_field() + """Error object that describes the error when status is \"Failed\".""" + result: Optional["_models.RadiologyInsightsInferenceResult"] = rest_field() + """The result of the operation.""" + + @overload + def __init__( + self, + *, + error: Optional["_models.Error"] = None, + result: Optional["_models.RadiologyInsightsInferenceResult"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Identifier(Element): + """An identifier intended for computation + Based on `FHIR Identifier `_. + + :ivar use: usual | official | temp | secondary | old (If known). + :vartype use: str + :ivar type: Description of identifier. + :vartype type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar system: The namespace for the identifier value. + :vartype system: str + :ivar value: The value that is unique. + :vartype value: str + :ivar period: Time period when id is/was valid for use. + :vartype period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar assigner: Organization that issued id (may be just text). + :vartype assigner: ~azure.healthinsights.radiologyinsights.models.Reference + """ + + use: Optional[str] = rest_field() + """usual | official | temp | secondary | old (If known).""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Description of identifier.""" + system: Optional[str] = rest_field() + """The namespace for the identifier value.""" + value: Optional[str] = rest_field() + """The value that is unique.""" + period: Optional["_models.Period"] = rest_field() + """Time period when id is/was valid for use.""" + assigner: Optional["_models.Reference"] = rest_field() + """Organization that issued id (may be just text).""" + + @overload + def __init__( + self, + *, + use: Optional[str] = None, + type: Optional["_models.CodeableConcept"] = None, + system: Optional[str] = None, + value: Optional[str] = None, + period: Optional["_models.Period"] = None, + assigner: Optional["_models.Reference"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ImagingProcedure(_model_base.Model): + """Imaging procedure. + + All required parameters must be populated in order to send to server. + + :ivar modality: Modality : SNOMED CT code. Required. + :vartype modality: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar anatomy: Anatomy : SNOMED CT code. Required. + :vartype anatomy: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar laterality: Laterality : SNOMED CT code. + :vartype laterality: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar contrast: Contrast : see RadiologyCodeWithTypes (below). + :vartype contrast: ~azure.healthinsights.radiologyinsights.models.RadiologyCodeWithTypes + :ivar view: View : see RadiologyCodeWithTypes (below). + :vartype view: ~azure.healthinsights.radiologyinsights.models.RadiologyCodeWithTypes + """ + + modality: "_models.CodeableConcept" = rest_field() + """Modality : SNOMED CT code. Required.""" + anatomy: "_models.CodeableConcept" = rest_field() + """Anatomy : SNOMED CT code. Required.""" + laterality: Optional["_models.CodeableConcept"] = rest_field() + """Laterality : SNOMED CT code.""" + contrast: Optional["_models.RadiologyCodeWithTypes"] = rest_field() + """Contrast : see RadiologyCodeWithTypes (below).""" + view: Optional["_models.RadiologyCodeWithTypes"] = rest_field() + """View : see RadiologyCodeWithTypes (below).""" + + @overload + def __init__( + self, + *, + modality: "_models.CodeableConcept", + anatomy: "_models.CodeableConcept", + laterality: Optional["_models.CodeableConcept"] = None, + contrast: Optional["_models.RadiologyCodeWithTypes"] = None, + view: Optional["_models.RadiologyCodeWithTypes"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ImagingProcedureRecommendation(ProcedureRecommendation, discriminator="imagingProcedureRecommendation"): + """Imaging procedures. + + All required parameters must be populated in order to send to server. + + :ivar kind: Procedure type : imaging. Required. Default value is + "imagingProcedureRecommendation". + :vartype kind: str + :ivar procedure_codes: LOINC codes for the procedure. + :vartype procedure_codes: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar imaging_procedures: Imaging procedures. Required. + :vartype imaging_procedures: + list[~azure.healthinsights.radiologyinsights.models.ImagingProcedure] + """ + + kind: Literal["imagingProcedureRecommendation"] = rest_discriminator(name="kind") # type: ignore + """Procedure type : imaging. Required. Default value is \"imagingProcedureRecommendation\".""" + procedure_codes: Optional[List["_models.CodeableConcept"]] = rest_field(name="procedureCodes") + """LOINC codes for the procedure.""" + imaging_procedures: List["_models.ImagingProcedure"] = rest_field(name="imagingProcedures") + """Imaging procedures. Required.""" + + @overload + def __init__( + self, + *, + imaging_procedures: List["_models.ImagingProcedure"], + procedure_codes: Optional[List["_models.CodeableConcept"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind="imagingProcedureRecommendation", **kwargs) + + +class InnerError(_model_base.Model): + """An object containing more specific information about the error. As per Microsoft One API + guidelines - + https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + + :ivar code: One of a server-defined set of error codes. + :vartype code: str + :ivar innererror: Inner error. + :vartype innererror: ~azure.healthinsights.radiologyinsights.models.InnerError + """ + + code: Optional[str] = rest_field() + """One of a server-defined set of error codes.""" + innererror: Optional["_models.InnerError"] = rest_field() + """Inner error.""" + + @overload + def __init__( + self, + *, + code: Optional[str] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class LateralityDiscrepancyInference(RadiologyInsightsInference, discriminator="lateralityDiscrepancy"): + """A laterality mismatch occurs when there is a discrepancy between the clinical documentation and + the ordered procedure (orderLateralityMismatch), a contradiction within the clinical document + (textLateralityContradiction), or when no laterality is mentioned (textLateralityMissing). + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Laterality discrepancy inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.LATERALITY_DISCREPANCY + :ivar laterality_indication: Laterality indication : SNOMED CT code for laterality qualifier + value. + :vartype laterality_indication: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar discrepancy_type: Mismatch type : orderLateralityMismatch, textLateralityContradiction, + textLateralityMissing. Required. Known values are: "orderLateralityMismatch", + "textLateralityContradiction", and "textLateralityMissing". + :vartype discrepancy_type: str or + ~azure.healthinsights.radiologyinsights.models.LateralityDiscrepancyType + """ + + kind: Literal[RadiologyInsightsInferenceType.LATERALITY_DISCREPANCY] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Laterality discrepancy inference type""" + laterality_indication: Optional["_models.CodeableConcept"] = rest_field(name="lateralityIndication") + """Laterality indication : SNOMED CT code for laterality qualifier value.""" + discrepancy_type: Union[str, "_models.LateralityDiscrepancyType"] = rest_field(name="discrepancyType") + """Mismatch type : orderLateralityMismatch, textLateralityContradiction, textLateralityMissing. + Required. Known values are: \"orderLateralityMismatch\", \"textLateralityContradiction\", and + \"textLateralityMissing\".""" + + @overload + def __init__( + self, + *, + discrepancy_type: Union[str, "_models.LateralityDiscrepancyType"], + extension: Optional[List["_models.Extension"]] = None, + laterality_indication: Optional["_models.CodeableConcept"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RadiologyInsightsInferenceType.LATERALITY_DISCREPANCY, **kwargs) + + +class LimitedOrderDiscrepancyInference(RadiologyInsightsInference, discriminator="limitedOrderDiscrepancy"): + """A limited order discrepancy occurs when there is a limited order, but all body parts and + measurements that are needed for a complete order are present in the document. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Limited order discrepancy inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.LIMITED_ORDER_DISCREPANCY + :ivar order_type: Order type : CPT ultrasound complete code for abdomen, retroperitoneal, + pelvis or breast. Required. + :vartype order_type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar present_body_parts: List of body parts found in the document : SNOMED CT codes. + :vartype present_body_parts: + list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar present_body_part_measurements: List of body parts that are measured according to the + document : SNOMED CT codes. + :vartype present_body_part_measurements: + list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + """ + + kind: Literal[RadiologyInsightsInferenceType.LIMITED_ORDER_DISCREPANCY] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Limited order discrepancy inference type""" + order_type: "_models.CodeableConcept" = rest_field(name="orderType") + """Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast. + Required.""" + present_body_parts: Optional[List["_models.CodeableConcept"]] = rest_field(name="presentBodyParts") + """List of body parts found in the document : SNOMED CT codes.""" + present_body_part_measurements: Optional[List["_models.CodeableConcept"]] = rest_field( + name="presentBodyPartMeasurements" + ) + """List of body parts that are measured according to the document : SNOMED CT codes.""" + + @overload + def __init__( + self, + *, + order_type: "_models.CodeableConcept", + extension: Optional[List["_models.Extension"]] = None, + present_body_parts: Optional[List["_models.CodeableConcept"]] = None, + present_body_part_measurements: Optional[List["_models.CodeableConcept"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RadiologyInsightsInferenceType.LIMITED_ORDER_DISCREPANCY, **kwargs) + + +class Meta(_model_base.Model): + """Metadata about a resource + Based on `FHIR Meta `_. + + :ivar version_id: The version specific identifier, as it appears in the version portion of the + URL. This value changes when the resource is created, updated, or deleted. + :vartype version_id: str + :ivar last_updated: When the resource last changed - e.g. when the version changed. + :vartype last_updated: str + :ivar source: A uri that identifies the source system of the resource. This provides a minimal + amount of Provenance information that can be used to track or differentiate the source of + information in the resource. The source may identify another FHIR server, document, message, + database, etc. + :vartype source: str + :ivar profile: A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_. + :vartype profile: list[str] + :ivar security: Security labels applied to this resource. These tags connect specific resources + to the overall security policy and infrastructure. + :vartype security: list[~azure.healthinsights.radiologyinsights.models.Coding] + :ivar tag: Tags applied to this resource. Tags are intended to be used to identify and relate + resources to process and workflow, and applications are not required to consider the tags when + interpreting the meaning of a resource. + :vartype tag: list[~azure.healthinsights.radiologyinsights.models.Coding] + """ + + version_id: Optional[str] = rest_field(name="versionId") + """The version specific identifier, as it appears in the version portion of the URL. This value + changes when the resource is created, updated, or deleted.""" + last_updated: Optional[str] = rest_field(name="lastUpdated") + """When the resource last changed - e.g. when the version changed.""" + source: Optional[str] = rest_field() + """A uri that identifies the source system of the resource. This provides a minimal amount of + Provenance information that can be used to track or differentiate the source of information in + the resource. The source may identify another FHIR server, document, message, database, etc.""" + profile: Optional[List[str]] = rest_field() + """A list of profiles (references to `StructureDefinition + `_ resources) that this resource claims to + conform to. The URL is a reference to `StructureDefinition.url + `_.""" + security: Optional[List["_models.Coding"]] = rest_field() + """Security labels applied to this resource. These tags connect specific resources to the overall + security policy and infrastructure.""" + tag: Optional[List["_models.Coding"]] = rest_field() + """Tags applied to this resource. Tags are intended to be used to identify and relate resources to + process and workflow, and applications are not required to consider the tags when interpreting + the meaning of a resource.""" + + @overload + def __init__( + self, + *, + version_id: Optional[str] = None, + last_updated: Optional[str] = None, + source: Optional[str] = None, + profile: Optional[List[str]] = None, + security: Optional[List["_models.Coding"]] = None, + tag: Optional[List["_models.Coding"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Narrative(Element): + """Any resource that is a `DomainResource `_ may + include a human-readable narrative that contains a summary of the resource and may be used to + represent the content of the resource to a human. + Based on `FHIR Narrative `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar status: generated, extensions, additional, empty. Required. + :vartype status: str + :ivar div: xhtml. Required. + :vartype div: str + """ + + status: str = rest_field() + """generated, extensions, additional, empty. Required.""" + div: str = rest_field() + """xhtml. Required.""" + + @overload + def __init__( + self, + *, + status: str, + div: str, + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Observation(DomainResource): # pylint: disable=too-many-instance-attributes + """Detailed information about observations + Based on `FHIR Observation `_. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.radiologyinsights.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.radiologyinsights.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.radiologyinsights.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "Observation". + :vartype resource_type: str + :ivar identifier: Business Identifier for observation. + :vartype identifier: list[~azure.healthinsights.radiologyinsights.models.Identifier] + :ivar status: registered | preliminary | final | amended +. Required. Known values are: + "registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", + and "unknown". + :vartype status: str or + ~azure.healthinsights.radiologyinsights.models.ObservationStatusCodeType + :ivar category: Classification of type of observation. + :vartype category: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar code: Type of observation (code / type). Required. + :vartype code: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar subject: Who and/or what the observation is about. + :vartype subject: ~azure.healthinsights.radiologyinsights.models.Reference + :ivar encounter: Healthcare event during which this observation is made. + :vartype encounter: ~azure.healthinsights.radiologyinsights.models.Reference + :ivar effective_date_time: Clinically relevant time/time-period for observation. + :vartype effective_date_time: str + :ivar effective_period: Clinically relevant time/time-period for observation. + :vartype effective_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar effective_instant: Clinically relevant time/time-period for observation. + :vartype effective_instant: str + :ivar issued: Date/Time this version was made available. + :vartype issued: str + :ivar value_quantity: Actual result. + :vartype value_quantity: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar value_codeable_concept: Actual result. + :vartype value_codeable_concept: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar value_string: Actual result. + :vartype value_string: str + :ivar value_boolean: Actual result. + :vartype value_boolean: bool + :ivar value_integer: Actual result. + :vartype value_integer: int + :ivar value_range: Actual result. + :vartype value_range: ~azure.healthinsights.radiologyinsights.models.Range + :ivar value_ratio: Actual result. + :vartype value_ratio: ~azure.healthinsights.radiologyinsights.models.Ratio + :ivar value_sampled_data: Actual result. + :vartype value_sampled_data: ~azure.healthinsights.radiologyinsights.models.SampledData + :ivar value_time: Actual result. + :vartype value_time: ~datetime.time + :ivar value_date_time: Actual result. + :vartype value_date_time: str + :ivar value_period: Actual result. + :vartype value_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar data_absent_reason: Why the result is missing. + :vartype data_absent_reason: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar interpretation: High, low, normal, etc. + :vartype interpretation: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar note: Comments about the observation. + :vartype note: list[~azure.healthinsights.radiologyinsights.models.Annotation] + :ivar body_site: Observed body part. + :vartype body_site: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar method: How it was done. + :vartype method: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar reference_range: Provides guide for interpretation. + :vartype reference_range: + list[~azure.healthinsights.radiologyinsights.models.ObservationReferenceRange] + :ivar has_member: Related resource that belongs to the Observation group. + :vartype has_member: list[~azure.healthinsights.radiologyinsights.models.Reference] + :ivar derived_from: Related measurements the observation is made from. + :vartype derived_from: list[~azure.healthinsights.radiologyinsights.models.Reference] + :ivar component: Component results. + :vartype component: list[~azure.healthinsights.radiologyinsights.models.ObservationComponent] + """ + + resource_type: Literal["Observation"] = rest_field(name="resourceType") + """resourceType. Required. Default value is \"Observation\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """Business Identifier for observation.""" + status: Union[str, "_models.ObservationStatusCodeType"] = rest_field() + """registered | preliminary | final | amended +. Required. Known values are: \"registered\", + \"preliminary\", \"final\", \"amended\", \"corrected\", \"cancelled\", \"entered-in-error\", + and \"unknown\".""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """Classification of type of observation.""" + code: "_models.CodeableConcept" = rest_field() + """Type of observation (code / type). Required.""" + subject: Optional["_models.Reference"] = rest_field() + """Who and/or what the observation is about.""" + encounter: Optional["_models.Reference"] = rest_field() + """Healthcare event during which this observation is made.""" + effective_date_time: Optional[str] = rest_field(name="effectiveDateTime") + """Clinically relevant time/time-period for observation.""" + effective_period: Optional["_models.Period"] = rest_field(name="effectivePeriod") + """Clinically relevant time/time-period for observation.""" + effective_instant: Optional[str] = rest_field(name="effectiveInstant") + """Clinically relevant time/time-period for observation.""" + issued: Optional[str] = rest_field() + """Date/Time this version was made available.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Actual result.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Actual result.""" + value_string: Optional[str] = rest_field(name="valueString") + """Actual result.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Actual result.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Actual result.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Actual result.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Actual result.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Actual result.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Actual result.""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Actual result.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Actual result.""" + data_absent_reason: Optional["_models.CodeableConcept"] = rest_field(name="dataAbsentReason") + """Why the result is missing.""" + interpretation: Optional[List["_models.CodeableConcept"]] = rest_field() + """High, low, normal, etc.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Comments about the observation.""" + body_site: Optional["_models.CodeableConcept"] = rest_field(name="bodySite") + """Observed body part.""" + method: Optional["_models.CodeableConcept"] = rest_field() + """How it was done.""" + reference_range: Optional[List["_models.ObservationReferenceRange"]] = rest_field(name="referenceRange") + """Provides guide for interpretation.""" + has_member: Optional[List["_models.Reference"]] = rest_field(name="hasMember") + """Related resource that belongs to the Observation group.""" + derived_from: Optional[List["_models.Reference"]] = rest_field(name="derivedFrom") + """Related measurements the observation is made from.""" + component: Optional[List["_models.ObservationComponent"]] = rest_field() + """Component results.""" + + @overload + def __init__( + self, + *, + status: Union[str, "_models.ObservationStatusCodeType"], + code: "_models.CodeableConcept", + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + subject: Optional["_models.Reference"] = None, + encounter: Optional["_models.Reference"] = None, + effective_date_time: Optional[str] = None, + effective_period: Optional["_models.Period"] = None, + effective_instant: Optional[str] = None, + issued: Optional[str] = None, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + data_absent_reason: Optional["_models.CodeableConcept"] = None, + interpretation: Optional[List["_models.CodeableConcept"]] = None, + note: Optional[List["_models.Annotation"]] = None, + body_site: Optional["_models.CodeableConcept"] = None, + method: Optional["_models.CodeableConcept"] = None, + reference_range: Optional[List["_models.ObservationReferenceRange"]] = None, + has_member: Optional[List["_models.Reference"]] = None, + derived_from: Optional[List["_models.Reference"]] = None, + component: Optional[List["_models.ObservationComponent"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.resource_type: Literal["Observation"] = "Observation" + + +class ObservationComponent(Element): # pylint: disable=too-many-instance-attributes + """Component results + Based on `FHIR Observation.component `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique id for inter-element referencing. + :vartype id: str + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar code: Type of component observation (code / type). Required. + :vartype code: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar value_quantity: Value as Quantity. + :vartype value_quantity: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar value_codeable_concept: Value as CodeableConcept. + :vartype value_codeable_concept: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar value_string: Value as string. + :vartype value_string: str + :ivar value_boolean: Value as boolean. + :vartype value_boolean: bool + :ivar value_integer: Value as integer. + :vartype value_integer: int + :ivar value_range: Value as Range. + :vartype value_range: ~azure.healthinsights.radiologyinsights.models.Range + :ivar value_ratio: Value as Ratio. + :vartype value_ratio: ~azure.healthinsights.radiologyinsights.models.Ratio + :ivar value_sampled_data: Value as SampledData. + :vartype value_sampled_data: ~azure.healthinsights.radiologyinsights.models.SampledData + :ivar value_time: Value as time (hh:mm:ss). + :vartype value_time: ~datetime.time + :ivar value_date_time: Value as dateTime. + :vartype value_date_time: str + :ivar value_period: Value as Period. + :vartype value_period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar value_reference: Value as reference. + :vartype value_reference: ~azure.healthinsights.radiologyinsights.models.Reference + :ivar data_absent_reason: Why the component result is missing. + :vartype data_absent_reason: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar interpretation: High, low, normal, etc. + :vartype interpretation: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar reference_range: Provides guide for interpretation of component result. + :vartype reference_range: + list[~azure.healthinsights.radiologyinsights.models.ObservationReferenceRange] + """ + + code: "_models.CodeableConcept" = rest_field() + """Type of component observation (code / type). Required.""" + value_quantity: Optional["_models.Quantity"] = rest_field(name="valueQuantity") + """Value as Quantity.""" + value_codeable_concept: Optional["_models.CodeableConcept"] = rest_field(name="valueCodeableConcept") + """Value as CodeableConcept.""" + value_string: Optional[str] = rest_field(name="valueString") + """Value as string.""" + value_boolean: Optional[bool] = rest_field(name="valueBoolean") + """Value as boolean.""" + value_integer: Optional[int] = rest_field(name="valueInteger") + """Value as integer.""" + value_range: Optional["_models.Range"] = rest_field(name="valueRange") + """Value as Range.""" + value_ratio: Optional["_models.Ratio"] = rest_field(name="valueRatio") + """Value as Ratio.""" + value_sampled_data: Optional["_models.SampledData"] = rest_field(name="valueSampledData") + """Value as SampledData.""" + value_time: Optional[datetime.time] = rest_field(name="valueTime") + """Value as time (hh:mm:ss).""" + value_date_time: Optional[str] = rest_field(name="valueDateTime") + """Value as dateTime.""" + value_period: Optional["_models.Period"] = rest_field(name="valuePeriod") + """Value as Period.""" + value_reference: Optional["_models.Reference"] = rest_field(name="valueReference") + """Value as reference.""" + data_absent_reason: Optional["_models.CodeableConcept"] = rest_field(name="dataAbsentReason") + """Why the component result is missing.""" + interpretation: Optional[List["_models.CodeableConcept"]] = rest_field() + """High, low, normal, etc.""" + reference_range: Optional[List["_models.ObservationReferenceRange"]] = rest_field(name="referenceRange") + """Provides guide for interpretation of component result.""" + + @overload + def __init__( + self, + *, + code: "_models.CodeableConcept", + id: Optional[str] = None, # pylint: disable=redefined-builtin + extension: Optional[List["_models.Extension"]] = None, + value_quantity: Optional["_models.Quantity"] = None, + value_codeable_concept: Optional["_models.CodeableConcept"] = None, + value_string: Optional[str] = None, + value_boolean: Optional[bool] = None, + value_integer: Optional[int] = None, + value_range: Optional["_models.Range"] = None, + value_ratio: Optional["_models.Ratio"] = None, + value_sampled_data: Optional["_models.SampledData"] = None, + value_time: Optional[datetime.time] = None, + value_date_time: Optional[str] = None, + value_period: Optional["_models.Period"] = None, + value_reference: Optional["_models.Reference"] = None, + data_absent_reason: Optional["_models.CodeableConcept"] = None, + interpretation: Optional[List["_models.CodeableConcept"]] = None, + reference_range: Optional[List["_models.ObservationReferenceRange"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ObservationReferenceRange(_model_base.Model): + """Provides guide for interpretation of component result + Based on `FHIR Observation.referenceRange `_. + + :ivar low: Low Range, if relevant. + :vartype low: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar high: High Range, if relevant. + :vartype high: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar type: Reference range qualifier. + :vartype type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar applies_to: Reference range population. + :vartype applies_to: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar age: Applicable age range, if relevant. + :vartype age: ~azure.healthinsights.radiologyinsights.models.Range + :ivar text: Text based reference range in an observation. + :vartype text: str + """ + + low: Optional["_models.Quantity"] = rest_field() + """Low Range, if relevant.""" + high: Optional["_models.Quantity"] = rest_field() + """High Range, if relevant.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Reference range qualifier.""" + applies_to: Optional[List["_models.CodeableConcept"]] = rest_field(name="appliesTo") + """Reference range population.""" + age: Optional["_models.Range"] = rest_field() + """Applicable age range, if relevant.""" + text: Optional[str] = rest_field() + """Text based reference range in an observation.""" + + @overload + def __init__( + self, + *, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, + type: Optional["_models.CodeableConcept"] = None, + applies_to: Optional[List["_models.CodeableConcept"]] = None, + age: Optional["_models.Range"] = None, + text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OrderedProcedure(_model_base.Model): + """Procedure information. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar code: Procedure code. + :vartype code: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar description: Procedure description. + :vartype description: str + """ + + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + code: Optional["_models.CodeableConcept"] = rest_field() + """Procedure code.""" + description: Optional[str] = rest_field() + """Procedure description.""" + + @overload + def __init__( + self, + *, + extension: Optional[List["_models.Extension"]] = None, + code: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientDetails(_model_base.Model): + """Patient structured information, including demographics and known structured clinical + information. + + :ivar sex: The patient's sex. Known values are: "female", "male", and "unspecified". + :vartype sex: str or ~azure.healthinsights.radiologyinsights.models.PatientSex + :ivar birth_date: The patient's date of birth. + :vartype birth_date: ~datetime.date + :ivar clinical_info: Known clinical information for the patient, structured. + :vartype clinical_info: list[~azure.healthinsights.radiologyinsights.models.Resource] + """ + + sex: Optional[Union[str, "_models.PatientSex"]] = rest_field() + """The patient's sex. Known values are: \"female\", \"male\", and \"unspecified\".""" + birth_date: Optional[datetime.date] = rest_field(name="birthDate") + """The patient's date of birth.""" + clinical_info: Optional[List["_models.Resource"]] = rest_field(name="clinicalInfo") + """Known clinical information for the patient, structured.""" + + @overload + def __init__( + self, + *, + sex: Optional[Union[str, "_models.PatientSex"]] = None, + birth_date: Optional[datetime.date] = None, + clinical_info: Optional[List["_models.Resource"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientDocument(_model_base.Model): + """A clinical document related to a patient. Document here is in the wide sense - not just a text + document (note). + + All required parameters must be populated in order to send to server. + + :ivar type: The type of the patient document, such as 'note' (text document) or 'fhirBundle' + (FHIR JSON document). Required. Known values are: "note", "fhirBundle", "dicom", and + "genomicSequencing". + :vartype type: str or ~azure.healthinsights.radiologyinsights.models.DocumentType + :ivar clinical_type: The type of the clinical document. Known values are: "consultation", + "dischargeSummary", "historyAndPhysical", "radiologyReport", "procedure", "progress", + "laboratory", and "pathologyReport". + :vartype clinical_type: str or + ~azure.healthinsights.radiologyinsights.models.ClinicalDocumentType + :ivar id: A given identifier for the document. Has to be unique across all documents for a + single patient. Required. + :vartype id: str + :ivar language: A 2 letter ISO 639-1 representation of the language of the document. + :vartype language: str + :ivar created_date_time: The date and time when the document was created. + :vartype created_date_time: ~datetime.datetime + :ivar authors: Document author(s). + :vartype authors: list[~azure.healthinsights.radiologyinsights.models.DocumentAuthor] + :ivar specialty_type: specialty type the document. Known values are: "pathology" and + "radiology". + :vartype specialty_type: str or ~azure.healthinsights.radiologyinsights.models.SpecialtyType + :ivar administrative_metadata: Administrative metadata for the document. + :vartype administrative_metadata: + ~azure.healthinsights.radiologyinsights.models.DocumentAdministrativeMetadata + :ivar content: The content of the patient document. Required. + :vartype content: ~azure.healthinsights.radiologyinsights.models.DocumentContent + """ + + type: Union[str, "_models.DocumentType"] = rest_field() + """The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON + document). Required. Known values are: \"note\", \"fhirBundle\", \"dicom\", and + \"genomicSequencing\".""" + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = rest_field(name="clinicalType") + """The type of the clinical document. Known values are: \"consultation\", \"dischargeSummary\", + \"historyAndPhysical\", \"radiologyReport\", \"procedure\", \"progress\", \"laboratory\", and + \"pathologyReport\".""" + id: str = rest_field() + """A given identifier for the document. Has to be unique across all documents for a single + patient. Required.""" + language: Optional[str] = rest_field() + """A 2 letter ISO 639-1 representation of the language of the document.""" + created_date_time: Optional[datetime.datetime] = rest_field(name="createdDateTime", format="rfc3339") + """The date and time when the document was created.""" + authors: Optional[List["_models.DocumentAuthor"]] = rest_field() + """Document author(s).""" + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = rest_field(name="specialtyType") + """specialty type the document. Known values are: \"pathology\" and \"radiology\".""" + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = rest_field( + name="administrativeMetadata" + ) + """Administrative metadata for the document.""" + content: "_models.DocumentContent" = rest_field() + """The content of the patient document. Required.""" + + @overload + def __init__( + self, + *, + type: Union[str, "_models.DocumentType"], + id: str, # pylint: disable=redefined-builtin + content: "_models.DocumentContent", + clinical_type: Optional[Union[str, "_models.ClinicalDocumentType"]] = None, + language: Optional[str] = None, + created_date_time: Optional[datetime.datetime] = None, + authors: Optional[List["_models.DocumentAuthor"]] = None, + specialty_type: Optional[Union[str, "_models.SpecialtyType"]] = None, + administrative_metadata: Optional["_models.DocumentAdministrativeMetadata"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PatientRecord(_model_base.Model): + """A patient record, including their clinical information and data. + + All required parameters must be populated in order to send to server. + + :ivar id: A given identifier for the patient. Has to be unique across all patients in a single + request. Required. + :vartype id: str + :ivar info: Patient structured information, including demographics and known structured + clinical information. + :vartype info: ~azure.healthinsights.radiologyinsights.models.PatientDetails + :ivar encounters: Patient encounters/visits. + :vartype encounters: list[~azure.healthinsights.radiologyinsights.models.Encounter] + :ivar patient_documents: Patient unstructured clinical data, given as documents. + :vartype patient_documents: + list[~azure.healthinsights.radiologyinsights.models.PatientDocument] + """ + + id: str = rest_field() + """A given identifier for the patient. Has to be unique across all patients in a single request. + Required.""" + info: Optional["_models.PatientDetails"] = rest_field() + """Patient structured information, including demographics and known structured clinical + information.""" + encounters: Optional[List["_models.Encounter"]] = rest_field() + """Patient encounters/visits.""" + patient_documents: Optional[List["_models.PatientDocument"]] = rest_field(name="patientDocuments") + """Patient unstructured clinical data, given as documents.""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + info: Optional["_models.PatientDetails"] = None, + encounters: Optional[List["_models.Encounter"]] = None, + patient_documents: Optional[List["_models.PatientDocument"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Period(Element): + """A time period defined by a start and end date and optionally time + Based on `FHIR Period `_. + + :ivar start: Starting time with inclusive boundary. + :vartype start: str + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: str + """ + + start: Optional[str] = rest_field() + """Starting time with inclusive boundary.""" + end: Optional[str] = rest_field() + """End time with inclusive boundary, if not ongoing.""" + + @overload + def __init__( + self, + *, + start: Optional[str] = None, + end: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Quantity(Element): + """A measured or measurable amount + Based on `FHIR Quantity `_. + + :ivar value: Numerical value (with implicit precision). + :vartype value: float + :ivar comparator: < | <= | >= | > - how to understand the value. + :vartype comparator: str + :ivar unit: Unit representation. + :vartype unit: str + :ivar system: System that defines coded unit form. + :vartype system: str + :ivar code: Coded form of the unit. + :vartype code: str + """ + + value: Optional[float] = rest_field() + """Numerical value (with implicit precision).""" + comparator: Optional[str] = rest_field() + """< | <= | >= | > - how to understand the value.""" + unit: Optional[str] = rest_field() + """Unit representation.""" + system: Optional[str] = rest_field() + """System that defines coded unit form.""" + code: Optional[str] = rest_field() + """Coded form of the unit.""" + + @overload + def __init__( + self, + *, + value: Optional[float] = None, + comparator: Optional[str] = None, + unit: Optional[str] = None, + system: Optional[str] = None, + code: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyCodeWithTypes(_model_base.Model): + """Radiology code with types : used in imaging procedure recommendation for contrast and view. + + All required parameters must be populated in order to send to server. + + :ivar code: The SNOMED CT code indicates whether imaging was conducted with or without contrast + in the case of contrast, and in the case of views, it denotes the number of views. Required. + :vartype code: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar types: The collection of types will indicate the contrast substance used in the case of + contrast and, in the case of views, it will specify the types of views, such as lateral and + frontal, etc. Required. + :vartype types: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + """ + + code: "_models.CodeableConcept" = rest_field() + """The SNOMED CT code indicates whether imaging was conducted with or without contrast in the case + of contrast, and in the case of views, it denotes the number of views. Required.""" + types: List["_models.CodeableConcept"] = rest_field() + """The collection of types will indicate the contrast substance used in the case of contrast and, + in the case of views, it will specify the types of views, such as lateral and frontal, etc. + Required.""" + + @overload + def __init__( + self, + *, + code: "_models.CodeableConcept", + types: List["_models.CodeableConcept"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyInsightsData(_model_base.Model): + """Contains the list of patients, and configuration data. + + All required parameters must be populated in order to send to server. + + :ivar patients: The list of patients, including their clinical information and data. Required. + :vartype patients: list[~azure.healthinsights.radiologyinsights.models.PatientRecord] + :ivar configuration: Configuration affecting the Radiology Insights model's inference. + :vartype configuration: + ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsModelConfiguration + """ + + patients: List["_models.PatientRecord"] = rest_field() + """The list of patients, including their clinical information and data. Required.""" + configuration: Optional["_models.RadiologyInsightsModelConfiguration"] = rest_field() + """Configuration affecting the Radiology Insights model's inference.""" + + @overload + def __init__( + self, + *, + patients: List["_models.PatientRecord"], + configuration: Optional["_models.RadiologyInsightsModelConfiguration"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyInsightsInferenceOptions(_model_base.Model): + """Options regarding follow up recommendation inferences and finding inferences. + + :ivar followup_recommendation_options: Follow-up recommendation options. + :vartype followup_recommendation_options: + ~azure.healthinsights.radiologyinsights.models.FollowupRecommendationOptions + :ivar finding_options: Finding options. + :vartype finding_options: ~azure.healthinsights.radiologyinsights.models.FindingOptions + """ + + followup_recommendation_options: Optional["_models.FollowupRecommendationOptions"] = rest_field( + name="followupRecommendationOptions" + ) + """Follow-up recommendation options.""" + finding_options: Optional["_models.FindingOptions"] = rest_field(name="findingOptions") + """Finding options.""" + + @overload + def __init__( + self, + *, + followup_recommendation_options: Optional["_models.FollowupRecommendationOptions"] = None, + finding_options: Optional["_models.FindingOptions"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyInsightsInferenceResult(_model_base.Model): + """The inference results for the Radiology Insights request. If field 'status' has value + 'succeeded', then field 'result' will contain an instance of RadiologyInsightsInferenceResult. + + All required parameters must be populated in order to send to server. + + :ivar patient_results: Results for the patients given in the request. Required. + :vartype patient_results: + list[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsPatientResult] + :ivar model_version: The version of the model used for inference, expressed as the model date. + Required. + :vartype model_version: str + """ + + patient_results: List["_models.RadiologyInsightsPatientResult"] = rest_field(name="patientResults") + """Results for the patients given in the request. Required.""" + model_version: str = rest_field(name="modelVersion") + """The version of the model used for inference, expressed as the model date. Required.""" + + @overload + def __init__( + self, + *, + patient_results: List["_models.RadiologyInsightsPatientResult"], + model_version: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyInsightsModelConfiguration(_model_base.Model): + """Configuration affecting the Radiology Insights model's inference. + + :ivar verbose: An indication whether the model should produce verbose output. + :vartype verbose: bool + :ivar include_evidence: An indication whether the model's output should include evidence for + the inferences. + :vartype include_evidence: bool + :ivar inference_types: This is a list of inference types to be inferred for the current + request. It could be used if only part of the Radiology Insights inferences are required. If + this list is omitted or empty, the model will return all the inference types. + :vartype inference_types: list[str or + ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceType] + :ivar inference_options: Options regarding follow up recommendation inferences and finding + inferences. + :vartype inference_options: + ~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInferenceOptions + :ivar locale: Local for the model to use. If not specified, the model will use the default + locale. + :vartype locale: str + """ + + verbose: Optional[bool] = rest_field() + """An indication whether the model should produce verbose output.""" + include_evidence: Optional[bool] = rest_field(name="includeEvidence") + """An indication whether the model's output should include evidence for the inferences.""" + inference_types: Optional[List[Union[str, "_models.RadiologyInsightsInferenceType"]]] = rest_field( + name="inferenceTypes" + ) + """This is a list of inference types to be inferred for the current request. It could be used if + only part of the Radiology Insights inferences are required. If this list is omitted or empty, + the model will return all the inference types.""" + inference_options: Optional["_models.RadiologyInsightsInferenceOptions"] = rest_field(name="inferenceOptions") + """Options regarding follow up recommendation inferences and finding inferences.""" + locale: Optional[str] = rest_field() + """Local for the model to use. If not specified, the model will use the default locale.""" + + @overload + def __init__( + self, + *, + verbose: Optional[bool] = None, + include_evidence: Optional[bool] = None, + inference_types: Optional[List[Union[str, "_models.RadiologyInsightsInferenceType"]]] = None, + inference_options: Optional["_models.RadiologyInsightsInferenceOptions"] = None, + locale: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyInsightsPatientResult(_model_base.Model): + """Results of the model's work for a single patient. + + All required parameters must be populated in order to send to server. + + :ivar patient_id: Identifier given for the patient in the request. Required. + :vartype patient_id: str + :ivar inferences: The model's inferences for the given patient. Required. + :vartype inferences: + list[~azure.healthinsights.radiologyinsights.models.RadiologyInsightsInference] + """ + + patient_id: str = rest_field(name="patientId") + """Identifier given for the patient in the request. Required.""" + inferences: List["_models.RadiologyInsightsInference"] = rest_field() + """The model's inferences for the given patient. Required.""" + + @overload + def __init__( + self, + *, + patient_id: str, + inferences: List["_models.RadiologyInsightsInference"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RadiologyProcedureInference(RadiologyInsightsInference, discriminator="radiologyProcedure"): + """Radiology procedures are the specific imaging studies or examinations ordered for the patient, + extracted from the document information and text. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Radiology Procedure inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.RADIOLOGY_PROCEDURE + :ivar procedure_codes: LOINC codes for the procedure. + :vartype procedure_codes: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar imaging_procedures: Imaging procedures. Required. + :vartype imaging_procedures: + list[~azure.healthinsights.radiologyinsights.models.ImagingProcedure] + :ivar ordered_procedure: Ordered procedure information from the document information or text. + Required. + :vartype ordered_procedure: ~azure.healthinsights.radiologyinsights.models.OrderedProcedure + """ + + kind: Literal[RadiologyInsightsInferenceType.RADIOLOGY_PROCEDURE] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Radiology Procedure inference type""" + procedure_codes: Optional[List["_models.CodeableConcept"]] = rest_field(name="procedureCodes") + """LOINC codes for the procedure.""" + imaging_procedures: List["_models.ImagingProcedure"] = rest_field(name="imagingProcedures") + """Imaging procedures. Required.""" + ordered_procedure: "_models.OrderedProcedure" = rest_field(name="orderedProcedure") + """Ordered procedure information from the document information or text. Required.""" + + @overload + def __init__( + self, + *, + imaging_procedures: List["_models.ImagingProcedure"], + ordered_procedure: "_models.OrderedProcedure", + extension: Optional[List["_models.Extension"]] = None, + procedure_codes: Optional[List["_models.CodeableConcept"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RadiologyInsightsInferenceType.RADIOLOGY_PROCEDURE, **kwargs) + + +class Range(Element): + """A set of ordered Quantities defined by a low and high limit + Based on `FHIR Range `_. + + :ivar low: Low limit. + :vartype low: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar high: High limit. + :vartype high: ~azure.healthinsights.radiologyinsights.models.Quantity + """ + + low: Optional["_models.Quantity"] = rest_field() + """Low limit.""" + high: Optional["_models.Quantity"] = rest_field() + """High limit.""" + + @overload + def __init__( + self, + *, + low: Optional["_models.Quantity"] = None, + high: Optional["_models.Quantity"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Ratio(Element): + """A ratio of two Quantity values - a numerator and a denominator + Based on `FHIR Ratio `_. + + :ivar numerator: Numerator value. + :vartype numerator: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar denominator: Denominator value. + :vartype denominator: ~azure.healthinsights.radiologyinsights.models.Quantity + """ + + numerator: Optional["_models.Quantity"] = rest_field() + """Numerator value.""" + denominator: Optional["_models.Quantity"] = rest_field() + """Denominator value.""" + + @overload + def __init__( + self, + *, + numerator: Optional["_models.Quantity"] = None, + denominator: Optional["_models.Quantity"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class RecommendationFinding(_model_base.Model): + """Finding reference for recommendation. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar finding: Finding linked to a recommendation. + :vartype finding: ~azure.healthinsights.radiologyinsights.models.Observation + :ivar critical_finding: Critical result linked to a recommendation. + :vartype critical_finding: ~azure.healthinsights.radiologyinsights.models.CriticalResult + :ivar recommendation_finding_status: Recommendation finding status. Required. Known values are: + "present", "differential", "ruleOut", and "conditional". + :vartype recommendation_finding_status: str or + ~azure.healthinsights.radiologyinsights.models.RecommendationFindingStatusType + """ + + extension: Optional[List["_models.Extension"]] = rest_field() + """Additional Content defined by implementations.""" + finding: Optional["_models.Observation"] = rest_field() + """Finding linked to a recommendation.""" + critical_finding: Optional["_models.CriticalResult"] = rest_field(name="criticalFinding") + """Critical result linked to a recommendation.""" + recommendation_finding_status: Union[str, "_models.RecommendationFindingStatusType"] = rest_field( + name="recommendationFindingStatus" + ) + """Recommendation finding status. Required. Known values are: \"present\", \"differential\", + \"ruleOut\", and \"conditional\".""" + + @overload + def __init__( + self, + *, + recommendation_finding_status: Union[str, "_models.RecommendationFindingStatusType"], + extension: Optional[List["_models.Extension"]] = None, + finding: Optional["_models.Observation"] = None, + critical_finding: Optional["_models.CriticalResult"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Reference(Element): + """A reference from one resource to another + Based on `FHIR Reference `_. + + :ivar reference: Literal reference, Relative, internal or absolute URL. + :vartype reference: str + :ivar type: Type the reference refers to (e.g. "Patient"). + :vartype type: str + :ivar identifier: Logical reference, when literal reference is not known. + :vartype identifier: ~azure.healthinsights.radiologyinsights.models.Identifier + :ivar display: Text alternative for the resource. + :vartype display: str + """ + + reference: Optional[str] = rest_field() + """Literal reference, Relative, internal or absolute URL.""" + type: Optional[str] = rest_field() + """Type the reference refers to (e.g. \"Patient\").""" + identifier: Optional["_models.Identifier"] = rest_field() + """Logical reference, when literal reference is not known.""" + display: Optional[str] = rest_field() + """Text alternative for the resource.""" + + @overload + def __init__( + self, + *, + reference: Optional[str] = None, + type: Optional[str] = None, + identifier: Optional["_models.Identifier"] = None, + display: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResearchStudy(DomainResource, discriminator="ResearchStudy"): # pylint: disable=too-many-instance-attributes + """Detailed information about Research Study + Based on `FHIR ResearchStudy `_. + + All required parameters must be populated in order to send to server. + + :ivar id: Resource Id. + :vartype id: str + :ivar meta: Metadata about the resource. + :vartype meta: ~azure.healthinsights.radiologyinsights.models.Meta + :ivar implicit_rules: A set of rules under which this content was created. + :vartype implicit_rules: str + :ivar language: Language of the resource content. + :vartype language: str + :ivar text: Text summary of the resource, for human interpretation. + :vartype text: ~azure.healthinsights.radiologyinsights.models.Narrative + :ivar contained: Contained, inline Resources. + :vartype contained: list[~azure.healthinsights.radiologyinsights.models.Resource] + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar modifier_extension: Extensions that cannot be ignored. + :vartype modifier_extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar resource_type: resourceType. Required. Default value is "ResearchStudy". + :vartype resource_type: str + :ivar identifier: Business Identifier for study. + :vartype identifier: list[~azure.healthinsights.radiologyinsights.models.Identifier] + :ivar title: Name for this study. + :vartype title: str + :ivar protocol: Steps followed in executing study. + :vartype protocol: list[~azure.healthinsights.radiologyinsights.models.Reference] + :ivar part_of: Part of larger study. + :vartype part_of: list[~azure.healthinsights.radiologyinsights.models.Reference] + :ivar status: active | administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | in-review | + temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: "active", "administratively-completed", "approved", + "closed-to-accrual", "closed-to-accrual-and-intervention", "completed", "disapproved", + "in-review", "temporarily-closed-to-accrual", "temporarily-closed-to-accrual-and-intervention", + and "withdrawn". + :vartype status: str or + ~azure.healthinsights.radiologyinsights.models.ResearchStudyStatusCodeType + :ivar primary_purpose_type: treatment | prevention | diagnostic | supportive-care | screening | + health-services-research | basic-science | device-feasibility. + :vartype primary_purpose_type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar phase: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | + phase-3 | phase-4. + :vartype phase: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar category: Classifications for the study. + :vartype category: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar focus: Drugs, devices, etc. under study. + :vartype focus: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar condition: Condition being studied. + :vartype condition: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar contact: Contact details for the study. + :vartype contact: list[~azure.healthinsights.radiologyinsights.models.ContactDetail] + :ivar keyword: Used to search for the study. + :vartype keyword: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar location: Geographic region(s) for study. + :vartype location: list[~azure.healthinsights.radiologyinsights.models.CodeableConcept] + :ivar description: What this is study doing. + :vartype description: str + :ivar enrollment: Inclusion & exclusion criteria. + :vartype enrollment: list[~azure.healthinsights.radiologyinsights.models.Reference] + :ivar period: When the study began and ended. + :vartype period: ~azure.healthinsights.radiologyinsights.models.Period + :ivar sponsor: Organization that initiates and is legally responsible for the study. + :vartype sponsor: ~azure.healthinsights.radiologyinsights.models.Reference + :ivar principal_investigator: Researcher who oversees multiple aspects of the study. + :vartype principal_investigator: ~azure.healthinsights.radiologyinsights.models.Reference + :ivar site: Facility where study activities are conducted. + :vartype site: list[~azure.healthinsights.radiologyinsights.models.Reference] + :ivar reason_stopped: accrual-goal-met | closed-due-to-toxicity | + closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design. + :vartype reason_stopped: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar note: Comments made about the study. + :vartype note: list[~azure.healthinsights.radiologyinsights.models.Annotation] + :ivar arm: Defined path through the study for a subject. + :vartype arm: list[~azure.healthinsights.radiologyinsights.models.ResearchStudyArm] + :ivar objective: A goal for the study. + :vartype objective: list[~azure.healthinsights.radiologyinsights.models.ResearchStudyObjective] + """ + + resource_type: Literal["ResearchStudy"] = rest_discriminator(name="resourceType") # type: ignore + """resourceType. Required. Default value is \"ResearchStudy\".""" + identifier: Optional[List["_models.Identifier"]] = rest_field() + """Business Identifier for study.""" + title: Optional[str] = rest_field() + """Name for this study.""" + protocol: Optional[List["_models.Reference"]] = rest_field() + """Steps followed in executing study.""" + part_of: Optional[List["_models.Reference"]] = rest_field(name="partOf") + """Part of larger study.""" + status: Union[str, "_models.ResearchStudyStatusCodeType"] = rest_field() + """active | administratively-completed | approved | closed-to-accrual | + closed-to-accrual-and-intervention | completed | disapproved | in-review | + temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn. + Required. Known values are: \"active\", \"administratively-completed\", \"approved\", + \"closed-to-accrual\", \"closed-to-accrual-and-intervention\", \"completed\", \"disapproved\", + \"in-review\", \"temporarily-closed-to-accrual\", + \"temporarily-closed-to-accrual-and-intervention\", and \"withdrawn\".""" + primary_purpose_type: Optional["_models.CodeableConcept"] = rest_field(name="primaryPurposeType") + """treatment | prevention | diagnostic | supportive-care | screening | health-services-research | + basic-science | device-feasibility.""" + phase: Optional["_models.CodeableConcept"] = rest_field() + """n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | + phase-4.""" + category: Optional[List["_models.CodeableConcept"]] = rest_field() + """Classifications for the study.""" + focus: Optional[List["_models.CodeableConcept"]] = rest_field() + """Drugs, devices, etc. under study.""" + condition: Optional[List["_models.CodeableConcept"]] = rest_field() + """Condition being studied.""" + contact: Optional[List["_models.ContactDetail"]] = rest_field() + """Contact details for the study.""" + keyword: Optional[List["_models.CodeableConcept"]] = rest_field() + """Used to search for the study.""" + location: Optional[List["_models.CodeableConcept"]] = rest_field() + """Geographic region(s) for study.""" + description: Optional[str] = rest_field() + """What this is study doing.""" + enrollment: Optional[List["_models.Reference"]] = rest_field() + """Inclusion & exclusion criteria.""" + period: Optional["_models.Period"] = rest_field() + """When the study began and ended.""" + sponsor: Optional["_models.Reference"] = rest_field() + """Organization that initiates and is legally responsible for the study.""" + principal_investigator: Optional["_models.Reference"] = rest_field(name="principalInvestigator") + """Researcher who oversees multiple aspects of the study.""" + site: Optional[List["_models.Reference"]] = rest_field() + """Facility where study activities are conducted.""" + reason_stopped: Optional["_models.CodeableConcept"] = rest_field(name="reasonStopped") + """accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | + temporarily-closed-per-study-design.""" + note: Optional[List["_models.Annotation"]] = rest_field() + """Comments made about the study.""" + arm: Optional[List["_models.ResearchStudyArm"]] = rest_field() + """Defined path through the study for a subject.""" + objective: Optional[List["_models.ResearchStudyObjective"]] = rest_field() + """A goal for the study.""" + + @overload + def __init__( + self, + *, + status: Union[str, "_models.ResearchStudyStatusCodeType"], + id: Optional[str] = None, # pylint: disable=redefined-builtin + meta: Optional["_models.Meta"] = None, + implicit_rules: Optional[str] = None, + language: Optional[str] = None, + text: Optional["_models.Narrative"] = None, + contained: Optional[List["_models.Resource"]] = None, + extension: Optional[List["_models.Extension"]] = None, + modifier_extension: Optional[List["_models.Extension"]] = None, + identifier: Optional[List["_models.Identifier"]] = None, + title: Optional[str] = None, + protocol: Optional[List["_models.Reference"]] = None, + part_of: Optional[List["_models.Reference"]] = None, + primary_purpose_type: Optional["_models.CodeableConcept"] = None, + phase: Optional["_models.CodeableConcept"] = None, + category: Optional[List["_models.CodeableConcept"]] = None, + focus: Optional[List["_models.CodeableConcept"]] = None, + condition: Optional[List["_models.CodeableConcept"]] = None, + contact: Optional[List["_models.ContactDetail"]] = None, + keyword: Optional[List["_models.CodeableConcept"]] = None, + location: Optional[List["_models.CodeableConcept"]] = None, + description: Optional[str] = None, + enrollment: Optional[List["_models.Reference"]] = None, + period: Optional["_models.Period"] = None, + sponsor: Optional["_models.Reference"] = None, + principal_investigator: Optional["_models.Reference"] = None, + site: Optional[List["_models.Reference"]] = None, + reason_stopped: Optional["_models.CodeableConcept"] = None, + note: Optional[List["_models.Annotation"]] = None, + arm: Optional[List["_models.ResearchStudyArm"]] = None, + objective: Optional[List["_models.ResearchStudyObjective"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, resource_type="ResearchStudy", **kwargs) + + +class ResearchStudyArm(_model_base.Model): + """ResearchStudyArm. + + All required parameters must be populated in order to send to server. + + :ivar name: Label for study arm. Required. + :vartype name: str + :ivar type: Categorization of study arm. + :vartype type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + :ivar description: Short explanation of study path. + :vartype description: str + """ + + name: str = rest_field() + """Label for study arm. Required.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """Categorization of study arm.""" + description: Optional[str] = rest_field() + """Short explanation of study path.""" + + @overload + def __init__( + self, + *, + name: str, + type: Optional["_models.CodeableConcept"] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResearchStudyObjective(_model_base.Model): + """ResearchStudyObjective. + + All required parameters must be populated in order to send to server. + + :ivar name: Label for the objective. Required. + :vartype name: str + :ivar type: primary | secondary | exploratory. + :vartype type: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + """ + + name: str = rest_field() + """Label for the objective. Required.""" + type: Optional["_models.CodeableConcept"] = rest_field() + """primary | secondary | exploratory.""" + + @overload + def __init__( + self, + *, + name: str, + type: Optional["_models.CodeableConcept"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SampledData(Element): + """A series of measurements taken by a device + Based on `FHIR SampledData `_. + + All required parameters must be populated in order to send to server. + + :ivar origin: Zero value and units. Required. + :vartype origin: ~azure.healthinsights.radiologyinsights.models.Quantity + :ivar period: Number of milliseconds between samples. Required. + :vartype period: float + :ivar factor: Multiply data by this before adding to origin. + :vartype factor: float + :ivar lower_limit: Lower limit of detection. + :vartype lower_limit: float + :ivar upper_limit: Upper limit of detection. + :vartype upper_limit: float + :ivar dimensions: Number of sample points at each time point. Required. + :vartype dimensions: int + :ivar data: Decimal values with spaces, or "E" | "U" | "L". + :vartype data: str + """ + + origin: "_models.Quantity" = rest_field() + """Zero value and units. Required.""" + period: float = rest_field() + """Number of milliseconds between samples. Required.""" + factor: Optional[float] = rest_field() + """Multiply data by this before adding to origin.""" + lower_limit: Optional[float] = rest_field(name="lowerLimit") + """Lower limit of detection.""" + upper_limit: Optional[float] = rest_field(name="upperLimit") + """Upper limit of detection.""" + dimensions: int = rest_field() + """Number of sample points at each time point. Required.""" + data: Optional[str] = rest_field() + """Decimal values with spaces, or \"E\" | \"U\" | \"L\".""" + + @overload + def __init__( + self, + *, + origin: "_models.Quantity", + period: float, + dimensions: int, + factor: Optional[float] = None, + lower_limit: Optional[float] = None, + upper_limit: Optional[float] = None, + data: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SexMismatchInference(RadiologyInsightsInference, discriminator="sexMismatch"): + """A notification for a sex mismatch is displayed when the gender, personal pronouns, + gender-related body parts, or gender-related procedures mentioned in a patient's clinical + document are either inconsistent or do not match the gender specified in the patient + information. + + All required parameters must be populated in order to send to server. + + :ivar extension: Additional Content defined by implementations. + :vartype extension: list[~azure.healthinsights.radiologyinsights.models.Extension] + :ivar kind: Inference type. Required. Sex mismatch inference type + :vartype kind: str or ~azure.healthinsights.radiologyinsights.models.SEX_MISMATCH + :ivar sex_indication: Sex indication : SNOMED CT code for gender finding. Required. + :vartype sex_indication: ~azure.healthinsights.radiologyinsights.models.CodeableConcept + """ + + kind: Literal[RadiologyInsightsInferenceType.SEX_MISMATCH] = rest_discriminator(name="kind") # type: ignore + """Inference type. Required. Sex mismatch inference type""" + sex_indication: "_models.CodeableConcept" = rest_field(name="sexIndication") + """Sex indication : SNOMED CT code for gender finding. Required.""" + + @overload + def __init__( + self, + *, + sex_indication: "_models.CodeableConcept", + extension: Optional[List["_models.Extension"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=RadiologyInsightsInferenceType.SEX_MISMATCH, **kwargs) + + +class TimePeriod(_model_base.Model): + """A duration of time during which an event is happening. + + :ivar start: Starting time with inclusive boundary. + :vartype start: ~datetime.datetime + :ivar end: End time with inclusive boundary, if not ongoing. + :vartype end: ~datetime.datetime + """ + + start: Optional[datetime.datetime] = rest_field(format="rfc3339") + """Starting time with inclusive boundary.""" + end: Optional[datetime.datetime] = rest_field(format="rfc3339") + """End time with inclusive boundary, if not ongoing.""" + + @overload + def __init__( + self, + *, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_patch.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/models/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/py.typed b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/azure/healthinsights/radiologyinsights/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/dev_requirements.txt b/sdk/healthinsights/azure-healthinsights-radiologyinsights/dev_requirements.txt new file mode 100644 index 000000000000..ff12ab35dd01 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/dev_requirements.txt @@ -0,0 +1,4 @@ +-e ../../../tools/azure-devtools +-e ../../../tools/azure-sdk-tools +../../core/azure-core +aiohttp \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/sdk_packaging.toml b/sdk/healthinsights/azure-healthinsights-radiologyinsights/sdk_packaging.toml new file mode 100644 index 000000000000..e7687fdae93b --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/sdk_packaging.toml @@ -0,0 +1,2 @@ +[packaging] +auto_update = false \ No newline at end of file diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/setup.py b/sdk/healthinsights/azure-healthinsights-radiologyinsights/setup.py new file mode 100644 index 000000000000..57be0108e385 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/setup.py @@ -0,0 +1,71 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# coding: utf-8 + +import os +import re +from setuptools import setup, find_packages + + +PACKAGE_NAME = "azure-healthinsights-radiologyinsights" +PACKAGE_PPRINT_NAME = "Azure Health Insights - Radiology Insights" + +# a-b-c => a/b/c +package_folder_path = PACKAGE_NAME.replace("-", "/") + +# Version extraction inspired from 'requests' +with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: + version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) + +if not version: + raise RuntimeError("Cannot find version information") + + +setup( + name=PACKAGE_NAME, + version=version, + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), + long_description=open("README.md", "r").read(), + long_description_content_type="text/markdown", + license="MIT License", + author="Microsoft Corporation", + author_email="azpysdkhelp@microsoft.com", + url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", + keywords="azure, azure sdk", + classifiers=[ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "License :: OSI Approved :: MIT License", + ], + zip_safe=False, + packages=find_packages( + exclude=[ + "tests", + # Exclude packages that will be covered by PEP420 or nspkg + "azure", + "azure.healthinsights", + ] + ), + include_package_data=True, + package_data={ + "azure.healthinsights.radiologyinsights": ["py.typed"], + }, + install_requires=[ + "isodate<1.0.0,>=0.6.1", + "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", + ], + python_requires=">=3.8", +) diff --git a/sdk/healthinsights/azure-healthinsights-radiologyinsights/tsp-location.yaml b/sdk/healthinsights/azure-healthinsights-radiologyinsights/tsp-location.yaml new file mode 100644 index 000000000000..ac82998a9980 --- /dev/null +++ b/sdk/healthinsights/azure-healthinsights-radiologyinsights/tsp-location.yaml @@ -0,0 +1,7 @@ +commit: 70a4ccdd2be61ae5bc524250c70270b0f4f2b540 +additionalDirectories: +- specification/ai/HealthInsights/HealthInsights.Common/ +- specification/ai/HealthInsights/HealthInsights.OpenAPI/ +repo: Azure/azure-rest-api-specs +directory: specification/ai/HealthInsights/HealthInsights.RadiologyInsights + diff --git a/sdk/healthinsights/ci.yml b/sdk/healthinsights/ci.yml index f59f6e7bf0d8..1029a03eddf3 100644 --- a/sdk/healthinsights/ci.yml +++ b/sdk/healthinsights/ci.yml @@ -37,3 +37,7 @@ extends: - name: azure-healthinsights-clinicalmatching safeName: azurehealthinsightsclinicalmatching skipVerifyChangeLog: true + - name: azure-healthinsights-patienttimeline + safeName: azurehealthinsightspatienttimeline + - name: azure-healthinsights-radiologyinsights + safeName: azurehealthinsightsradiologyinsights diff --git a/sdk/loadtesting/azure-developer-loadtesting/_meta.json b/sdk/loadtesting/azure-developer-loadtesting/_meta.json new file mode 100644 index 000000000000..45df7bb5c92d --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "70a4ccdd2be61ae5bc524250c70270b0f4f2b540", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/loadtestservice/LoadTestService", + "@azure-tools/typespec-python": "0.21.0" +} \ No newline at end of file diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/__init__.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/__init__.py index c9943fbd0915..d8df752ebf61 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/__init__.py +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/__init__.py @@ -1,10 +1,28 @@ -# ------------------------------------------------------------------------- +# coding=utf-8 +# -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._client import LoadTestAdministrationClient, LoadTestRunClient + +from ._client import LoadTestAdministrationClient +from ._client import LoadTestRunClient from ._version import VERSION __version__ = VERSION -__all__ = ["LoadTestAdministrationClient", "LoadTestRunClient"] + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "LoadTestAdministrationClient", + "LoadTestRunClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_client.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_client.py index c5c9808f7ed4..0b585d8edadc 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_client.py +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_client.py @@ -1,34 +1,69 @@ -# ------------------------------------------------------------------------- +# coding=utf-8 +# -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- + from copy import deepcopy from typing import Any, TYPE_CHECKING from azure.core import PipelineClient +from azure.core.pipeline import policies from azure.core.rest import HttpRequest, HttpResponse -from ._generated._configuration import LoadTestingClientConfiguration -from ._generated._serialization import Deserializer, Serializer -from ._generated.operations import AdministrationOperations, TestRunOperations +from ._configuration import LoadTestAdministrationClientConfiguration, LoadTestRunClientConfiguration +from ._operations import LoadTestAdministrationClientOperationsMixin, LoadTestRunClientOperationsMixin +from ._serialization import Deserializer, Serializer if TYPE_CHECKING: # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials import TokenCredential -class _BaseClient: + +class LoadTestAdministrationClient( + LoadTestAdministrationClientOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword + """LoadTestAdministrationClient. + + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: - _endpoint = "https://{Endpoint}" - self._config = LoadTestingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - self._client = PipelineClient(base_url=_endpoint, config=self._config, **kwargs) + _endpoint = "https://{endpoint}" + self._config = LoadTestAdministrationClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) self._serialize = Serializer() self._deserialize = Deserializer() self._serialize.client_side_validation = False - super().__init__(self._client, self._config, self._serialize, self._deserialize) - def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -48,50 +83,94 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: request_copy = deepcopy(request) path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore - def close(self): - # type: () -> None + def close(self) -> None: self._client.close() - def __exit__(self, *exc_details): - # type: (Any) -> None + def __enter__(self) -> "LoadTestAdministrationClient": + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: self._client.__exit__(*exc_details) -class LoadTestAdministrationClient(_BaseClient, AdministrationOperations): # pylint: disable=client-accepts-api-version-keyword - """These APIs allow end users to do various administrative operations on Azure Load Test Service. +class LoadTestRunClient(LoadTestRunClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + """LoadTestRunClient. - :param endpoint: URL to perform data plane API operations on the resource. Required. + :param endpoint: Required. :type endpoint: str :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.TokenCredential - :keyword api_version: Api Version. Default value is "2022-11-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ - def __enter__(self) -> "LoadTestAdministrationClient": - self._client.__enter__() - return self + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + _endpoint = "https://{endpoint}" + self._config = LoadTestRunClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) -class LoadTestRunClient(_BaseClient, TestRunOperations): # pylint: disable=client-accepts-api-version-keyword - """These APIs allow end users to run Azure Load Test and manage test run. + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False - :param endpoint: URL to perform data plane API operations on the resource. Required. - :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Required. - :type credential: ~azure.core.credentials.TokenCredential - :keyword api_version: Api Version. Default value is "2022-11-01". Note that overriding this - default value may result in unsupported behavior. - :paramtype api_version: str - """ + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() def __enter__(self) -> "LoadTestRunClient": self._client.__enter__() return self + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_configuration.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_configuration.py new file mode 100644 index 000000000000..01698ee61185 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_configuration.py @@ -0,0 +1,113 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies + +from ._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class LoadTestAdministrationClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for LoadTestAdministrationClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-04-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cnt-prod.loadtesting.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "developer-loadtesting/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.BearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) + + +class LoadTestRunClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for LoadTestRunClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-04-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cnt-prod.loadtesting.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "developer-loadtesting/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.BearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_model_base.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_model_base.py new file mode 100644 index 000000000000..1ddc071517d6 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_model_base.py @@ -0,0 +1,874 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except + +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import copy +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] # pylint: disable=protected-access + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): # pylint: disable=unsubscriptable-object + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = copy.deepcopy(data) + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: + ... + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: + ... + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + return self._data.popitem() + + def clear(self) -> None: + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: + ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: + ... + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument + # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' + mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") # pylint: disable=no-member + for k, v in mro_class.__annotations__.items() # pylint: disable=no-member + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) + + return super().__new__(cls) # pylint: disable=no-value-for-parameter + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): # pylint: disable=no-member + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: + for v in cls.__dict__.values(): + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access + return v._rest_name # pylint: disable=protected-access + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): # pylint: disable=no-member + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member + if mapped_cls == cls: + return cls(data) + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation or annotation in [int, float]: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + except AttributeError: + pass + + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) + + try: + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + obj: typing.Dict[typing.Any, typing.Any], + ): + if obj is None: + return obj + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + return functools.partial( + _deserialize_dict, + value_deserializer, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore + + def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, + ): + if obj is None: + return obj + return type(obj)( + _deserialize(deserializer, entry, module) + for entry, deserializer in zip(obj, entry_deserializers) + ) + + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + obj, + ): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + return functools.partial(_deserialize_sequence, deserializer) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): + try: + if value is None or isinstance(value, _Null): + return None + if deserializer is None: + return value + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/__init__.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/__init__.py new file mode 100644 index 000000000000..c433bf33381f --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/__init__.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import LoadTestAdministrationClientOperationsMixin +from ._operations import LoadTestRunClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "LoadTestAdministrationClientOperationsMixin", + "LoadTestRunClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/_operations.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/_operations.py new file mode 100644 index 000000000000..8a9342a010d8 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/_operations.py @@ -0,0 +1,8663 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import datetime +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Iterable, List, Optional, TypeVar, Union, overload +import urllib.parse + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.paging import ItemPaged +from azure.core.pipeline import PipelineResponse +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._model_base import SdkJSONEncoder, _deserialize +from .._serialization import Serializer +from .._vendor import LoadTestAdministrationClientMixinABC, LoadTestRunClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_load_test_administration_create_or_update_test_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_create_or_update_app_components_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/app-components" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_create_or_update_server_metrics_config_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/server-metrics-config" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_get_app_components_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/app-components" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_get_server_metrics_config_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/server-metrics-config" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_get_test_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_get_test_file_request( # pylint: disable=name-too-long + test_id: str, file_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/files/{fileName}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + "fileName": _SERIALIZER.url("file_name", file_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_list_test_files_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/files" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_list_tests_request( # pylint: disable=name-too-long + *, + orderby: Optional[str] = None, + search: Optional[str] = None, + last_modified_start_time: Optional[datetime.datetime] = None, + last_modified_end_time: Optional[datetime.datetime] = None, + maxpagesize: Optional[int] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if orderby is not None: + _params["orderby"] = _SERIALIZER.query("orderby", orderby, "str") + if search is not None: + _params["search"] = _SERIALIZER.query("search", search, "str") + if last_modified_start_time is not None: + _params["lastModifiedStartTime"] = _SERIALIZER.query( + "last_modified_start_time", last_modified_start_time, "iso-8601" + ) + if last_modified_end_time is not None: + _params["lastModifiedEndTime"] = _SERIALIZER.query("last_modified_end_time", last_modified_end_time, "iso-8601") + if maxpagesize is not None: + _params["maxpagesize"] = _SERIALIZER.query("maxpagesize", maxpagesize, "int") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_begin_upload_test_file_request( # pylint: disable=name-too-long + test_id: str, file_name: str, *, file_type: Optional[Union[str, _models.FileType]] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: str = kwargs.pop("content_type") + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/files/{fileName}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + "fileName": _SERIALIZER.url("file_name", file_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if file_type is not None: + _params["fileType"] = _SERIALIZER.query("file_type", file_type, "str") + + # Construct headers + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_delete_test_file_request( # pylint: disable=name-too-long + test_id: str, file_name: str, **kwargs: Any +) -> HttpRequest: + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + # Construct URL + _url = "/tests/{testId}/files/{fileName}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + "fileName": _SERIALIZER.url("file_name", file_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) + + +def build_load_test_administration_delete_test_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + # Construct URL + _url = "/tests/{testId}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) + + +def build_load_test_run_begin_test_run_request( # pylint: disable=name-too-long + test_run_id: str, *, old_test_run_id: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if old_test_run_id is not None: + _params["oldTestRunId"] = _SERIALIZER.query("old_test_run_id", old_test_run_id, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_create_or_update_app_components_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/app-components" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_create_or_update_server_metrics_config_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/server-metrics-config" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_delete_test_run_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + # Construct URL + _url = "/test-runs/{testRunId}" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) + + +def build_load_test_run_get_app_components_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/app-components" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_get_server_metrics_config_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/server-metrics-config" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_get_test_run_request(test_run_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_get_test_run_file_request( # pylint: disable=name-too-long + test_run_id: str, file_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/files/{fileName}" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + "fileName": _SERIALIZER.url("file_name", file_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_list_metric_dimension_values_request( # pylint: disable=name-too-long + test_run_id: str, + name: str, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + interval: Optional[Union[str, _models.TimeGrain]] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/metric-dimensions/{name}/values" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + "name": _SERIALIZER.url("name", name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + _params["metricname"] = _SERIALIZER.query("metricname", metricname, "str") + if interval is not None: + _params["interval"] = _SERIALIZER.query("interval", interval, "str") + _params["metricNamespace"] = _SERIALIZER.query("metric_namespace", metric_namespace, "str") + _params["timespan"] = _SERIALIZER.query("time_interval", time_interval, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_get_metric_definitions_request( # pylint: disable=name-too-long + test_run_id: str, *, metric_namespace: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/metric-definitions" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + _params["metricNamespace"] = _SERIALIZER.query("metric_namespace", metric_namespace, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_get_metric_namespaces_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/metric-namespaces" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_list_metrics_request( + test_run_id: str, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/metrics" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if aggregation is not None: + _params["aggregation"] = _SERIALIZER.query("aggregation", aggregation, "str") + _params["metricname"] = _SERIALIZER.query("metricname", metricname, "str") + if interval is not None: + _params["interval"] = _SERIALIZER.query("interval", interval, "str") + _params["metricNamespace"] = _SERIALIZER.query("metric_namespace", metric_namespace, "str") + _params["timespan"] = _SERIALIZER.query("time_interval", time_interval, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_list_test_runs_request( # pylint: disable=name-too-long + *, + orderby: Optional[str] = None, + search: Optional[str] = None, + test_id: Optional[str] = None, + execution_from: Optional[datetime.datetime] = None, + execution_to: Optional[datetime.datetime] = None, + status: Optional[str] = None, + maxpagesize: Optional[int] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if orderby is not None: + _params["orderby"] = _SERIALIZER.query("orderby", orderby, "str") + if search is not None: + _params["search"] = _SERIALIZER.query("search", search, "str") + if test_id is not None: + _params["testId"] = _SERIALIZER.query("test_id", test_id, "str") + if execution_from is not None: + _params["executionFrom"] = _SERIALIZER.query("execution_from", execution_from, "iso-8601") + if execution_to is not None: + _params["executionTo"] = _SERIALIZER.query("execution_to", execution_to, "iso-8601") + if status is not None: + _params["status"] = _SERIALIZER.query("status", status, "str") + if maxpagesize is not None: + _params["maxpagesize"] = _SERIALIZER.query("maxpagesize", maxpagesize, "int") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_stop_test_run_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}:stopTestRun" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +class LoadTestAdministrationClientOperationsMixin( # pylint: disable=name-too-long + LoadTestAdministrationClientMixinABC +): + @overload + def create_or_update_test( + self, test_id: str, body: _models.Test, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Required. + :type body: ~azure.developer.loadtesting.models.Test + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + """ + + @overload + def create_or_update_test( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + """ + + @overload + def create_or_update_test( + self, test_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + """ + + @distributed_trace + def create_or_update_test( + self, test_id: str, body: Union[_models.Test, JSON, IO[bytes]], **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Is one of the following types: Test, JSON, IO[bytes] + Required. + :type body: ~azure.developer.loadtesting.models.Test or JSON or IO[bytes] + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.Test] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_administration_create_or_update_test_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.Test, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.Test, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_or_update_app_components( + self, + test_id: str, + body: _models.TestAppComponents, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Required. + :type body: ~azure.developer.loadtesting.models.TestAppComponents + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + def create_or_update_app_components( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + def create_or_update_app_components( + self, test_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @distributed_trace + def create_or_update_app_components( + self, test_id: str, body: Union[_models.TestAppComponents, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Is one of the following types: TestAppComponents, JSON, + IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestAppComponents or JSON or IO[bytes] + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestAppComponents] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_administration_create_or_update_app_components_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestAppComponents, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_or_update_server_metrics_config( + self, + test_id: str, + body: _models.TestServerMetricConfig, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Required. + :type body: ~azure.developer.loadtesting.models.TestServerMetricConfig + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + def create_or_update_server_metrics_config( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + def create_or_update_server_metrics_config( + self, test_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @distributed_trace + def create_or_update_server_metrics_config( + self, test_id: str, body: Union[_models.TestServerMetricConfig, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Is one of the following types: + TestServerMetricConfig, JSON, IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestServerMetricConfig or JSON or IO[bytes] + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestServerMetricConfig] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_administration_create_or_update_server_metrics_config_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestServerMetricConfig, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_app_components(self, test_id: str, **kwargs: Any) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Get associated app component (collection of azure resources) for the given test. + + Get associated app component (collection of azure resources) for the given test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestAppComponents] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_app_components_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_server_metrics_config(self, test_id: str, **kwargs: Any) -> _models.TestServerMetricConfig: + """List server metrics configuration for the given test. + + List server metrics configuration for the given test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestServerMetricConfig] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_server_metrics_config_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_test(self, test_id: str, **kwargs: Any) -> _models.Test: + # pylint: disable=line-too-long + """Get load test details by test Id. + + Get load test details by test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.Test] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_test_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.Test, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_test_file(self, test_id: str, file_name: str, **kwargs: Any) -> _models.TestFileInfo: + # pylint: disable=line-too-long + """Get all the files that are associated with a test. + + Get all the files that are associated with a test. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param file_name: Name of the file. Required. + :type file_name: str + :return: TestFileInfo. The TestFileInfo is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestFileInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation failure error + details. + "validationStatus": "str" # Optional. Validation status of the file. Known + values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestFileInfo] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_test_file_request( + test_id=test_id, + file_name=file_name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestFileInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_test_files(self, test_id: str, **kwargs: Any) -> Iterable["_models.TestFileInfo"]: + # pylint: disable=line-too-long + """Get all test files. + + Get all test files. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: An iterator like instance of TestFileInfo + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.TestFileInfo] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation failure error + details. + "validationStatus": "str" # Optional. Validation status of the file. Known + values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.TestFileInfo]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_administration_list_test_files_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.TestFileInfo], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def list_tests( + self, + *, + orderby: Optional[str] = None, + search: Optional[str] = None, + last_modified_start_time: Optional[datetime.datetime] = None, + last_modified_end_time: Optional[datetime.datetime] = None, + **kwargs: Any + ) -> Iterable["_models.Test"]: + # pylint: disable=line-too-long + """Get all load tests by the fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + + Get all load tests by the fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + + :keyword orderby: Sort on the supported fields in (field asc/desc) format. eg: + lastModifiedDateTime asc. Supported fields - lastModifiedDateTime. Default value is None. + :paramtype orderby: str + :keyword search: Prefix based, case sensitive search on searchable fields - displayName, + createdBy. For example, to search for a test, with display name is Login Test, + the search parameter can be Login. Default value is None. + :paramtype search: str + :keyword last_modified_start_time: Start DateTime(RFC 3339 literal format) of the last updated + time range to filter tests. Default value is None. + :paramtype last_modified_start_time: ~datetime.datetime + :keyword last_modified_end_time: End DateTime(RFC 3339 literal format) of the last updated time + range to filter tests. Default value is None. + :paramtype last_modified_end_time: ~datetime.datetime + :return: An iterator like instance of Test + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.Test] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[List[_models.Test]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_administration_list_tests_request( + orderby=orderby, + search=search, + last_modified_start_time=last_modified_start_time, + last_modified_end_time=last_modified_end_time, + maxpagesize=maxpagesize, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.Test], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def begin_upload_test_file( + self, + test_id: str, + file_name: str, + body: bytes, + *, + file_type: Optional[Union[str, _models.FileType]] = None, + **kwargs: Any + ) -> _models.TestFileInfo: + # pylint: disable=line-too-long + """Upload input file for a given test Id. File size can't be more than 50 MB. + Existing file with same name for the given test will be overwritten. File + should be provided in the request body as application/octet-stream. + + Upload input file for a given test Id. File size can't be more than 50 MB. + Existing file with same name for the given test will be overwritten. File + should be provided in the request body as application/octet-stream. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param file_name: Unique name for test file with file extension like : App.jmx. Required. + :type file_name: str + :param body: The file content as application/octet-stream. Required. + :type body: bytes + :keyword file_type: File type. Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". Default value is None. + :paramtype file_type: str or ~azure.developer.loadtesting.models.FileType + :return: TestFileInfo. The TestFileInfo is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestFileInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation failure error + details. + "validationStatus": "str" # Optional. Validation status of the file. Known + values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: str = kwargs.pop("content_type", _headers.pop("content-type", "application/octet-stream")) + cls: ClsType[_models.TestFileInfo] = kwargs.pop("cls", None) + + _content = body + + _request = build_load_test_administration_begin_upload_test_file_request( + test_id=test_id, + file_name=file_name, + file_type=file_type, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestFileInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete_test_file( # pylint: disable=inconsistent-return-statements + self, test_id: str, file_name: str, **kwargs: Any + ) -> None: + """Delete file by the file name for a test. + + Delete file by the file name for a test. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param file_name: Name of the file. Required. + :type file_name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_load_test_administration_delete_test_file_request( + test_id=test_id, + file_name=file_name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def delete_test(self, test_id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete a test by its test Id. + + Delete a test by its test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_load_test_administration_delete_test_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + +class LoadTestRunClientOperationsMixin(LoadTestRunClientMixinABC): + @overload + def begin_test_run( + self, + test_run_id: str, + body: _models.TestRun, + *, + content_type: str = "application/merge-patch+json", + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Required. + :type body: ~azure.developer.loadtesting.models.TestRun + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + + @overload + def begin_test_run( + self, + test_run_id: str, + body: JSON, + *, + content_type: str = "application/merge-patch+json", + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + + @overload + def begin_test_run( + self, + test_run_id: str, + body: IO[bytes], + *, + content_type: str = "application/merge-patch+json", + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + + @distributed_trace + def begin_test_run( + self, + test_run_id: str, + body: Union[_models.TestRun, JSON, IO[bytes]], + *, + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Is one of the following types: TestRun, JSON, IO[bytes] + Required. + :type body: ~azure.developer.loadtesting.models.TestRun or JSON or IO[bytes] + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_run_begin_test_run_request( + test_run_id=test_run_id, + old_test_run_id=old_test_run_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_or_update_app_components( + self, + test_run_id: str, + body: _models.TestRunAppComponents, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Required. + :type body: ~azure.developer.loadtesting.models.TestRunAppComponents + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + def create_or_update_app_components( + self, test_run_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + def create_or_update_app_components( + self, test_run_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @distributed_trace + def create_or_update_app_components( + self, test_run_id: str, body: Union[_models.TestRunAppComponents, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Is one of the following types: TestRunAppComponents, JSON, + IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestRunAppComponents or JSON or IO[bytes] + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestRunAppComponents] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_run_create_or_update_app_components_request( + test_run_id=test_run_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunAppComponents, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_or_update_server_metrics_config( + self, + test_run_id: str, + body: _models.TestRunServerMetricConfig, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Required. + :type body: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + def create_or_update_server_metrics_config( + self, test_run_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + def create_or_update_server_metrics_config( + self, test_run_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @distributed_trace + def create_or_update_server_metrics_config( + self, test_run_id: str, body: Union[_models.TestRunServerMetricConfig, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Is one of the following types: + TestRunServerMetricConfig, JSON, IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestRunServerMetricConfig or JSON or IO[bytes] + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestRunServerMetricConfig] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_run_create_or_update_server_metrics_config_request( + test_run_id=test_run_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunServerMetricConfig, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete_test_run( # pylint: disable=inconsistent-return-statements + self, test_run_id: str, **kwargs: Any + ) -> None: + """Delete an existing load test run. + + Delete an existing load test run by providing the testRunId. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_load_test_run_delete_test_run_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def get_app_components(self, test_run_id: str, **kwargs: Any) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Get associated app component (collection of azure resources) for the given test + run. + + Get associated app component (collection of azure resources) for the given test + run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRunAppComponents] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_app_components_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_server_metrics_config(self, test_run_id: str, **kwargs: Any) -> _models.TestRunServerMetricConfig: + """Get associated server metrics configuration for the given test run. + + Get associated server metrics configuration for the given test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRunServerMetricConfig] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_server_metrics_config_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_test_run(self, test_run_id: str, **kwargs: Any) -> _models.TestRun: + # pylint: disable=line-too-long + """Get test run details by test run Id. + + Get test run details by test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_test_run_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_test_run_file(self, test_run_id: str, file_name: str, **kwargs: Any) -> _models.TestRunFileInfo: + # pylint: disable=line-too-long + """Get test run file by file name. + + Get test run file by file name. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param file_name: Name of the file. Required. + :type file_name: str + :return: TestRunFileInfo. The TestRunFileInfo is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunFileInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation failure error + details. + "validationStatus": "str" # Optional. Validation status of the file. Known + values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRunFileInfo] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_test_run_file_request( + test_run_id=test_run_id, + file_name=file_name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunFileInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_metric_dimension_values( + self, + test_run_id: str, + name: str, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + interval: Optional[Union[str, _models.TimeGrain]] = None, + **kwargs: Any + ) -> _models.DimensionValueList: + """List the dimension values for the given metric dimension name. + + List the dimension values for the given metric dimension name. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param name: Dimension name. Required. + :type name: str + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :return: DimensionValueList. The DimensionValueList is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.DimensionValueList + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "name": "str", # Optional. The dimension name. + "nextLink": "str", # Optional. Link for the next set of values in case of + paginated results, if applicable. + "value": [ + "str" # Optional. The dimension value. + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.DimensionValueList] = kwargs.pop("cls", None) + + _request = build_load_test_run_list_metric_dimension_values_request( + test_run_id=test_run_id, + name=name, + metricname=metricname, + metric_namespace=metric_namespace, + time_interval=time_interval, + interval=interval, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.DimensionValueList, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_metric_definitions( + self, test_run_id: str, *, metric_namespace: str, **kwargs: Any + ) -> _models.MetricDefinitionCollection: + # pylint: disable=line-too-long + """List the metric definitions for a load test run. + + List the metric definitions for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :return: MetricDefinitionCollection. The MetricDefinitionCollection is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.MetricDefinitionCollection + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "description": "str", # Optional. The metric description. + "dimensions": [ + { + "description": "str", # Optional. The + description. + "name": "str" # Optional. The name. + } + ], + "metricAvailabilities": [ + { + "timeGrain": "str" # Optional. The time + grain specifies the aggregation interval for the metric. + Expressed as a duration 'PT1M', 'PT1H', etc. Known values are: + "PT5S", "PT10S", "PT1M", "PT5M", and "PT1H". + } + ], + "name": "str", # Optional. The metric name. + "namespace": "str", # Optional. The namespace the metric + belongs to. + "primaryAggregationType": "str", # Optional. The primary + aggregation type value defining how to use the values for display. Known + values are: "Average", "Count", "None", "Total", "Percentile90", + "Percentile95", and "Percentile99". + "supportedAggregationTypes": [ + "str" # Optional. The collection of what all + aggregation types are supported. + ], + "unit": "str" # Optional. The unit of the metric. Known + values are: "NotSpecified", "Percent", "Count", "Seconds", + "Milliseconds", "Bytes", "BytesPerSecond", and "CountPerSecond". + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.MetricDefinitionCollection] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_metric_definitions_request( + test_run_id=test_run_id, + metric_namespace=metric_namespace, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.MetricDefinitionCollection, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_metric_namespaces(self, test_run_id: str, **kwargs: Any) -> _models.MetricNamespaceCollection: + """List the metric namespaces for a load test run. + + List the metric namespaces for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: MetricNamespaceCollection. The MetricNamespaceCollection is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.MetricNamespaceCollection + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "description": "str", # Optional. The namespace description. + "name": "str" # Optional. The metric namespace name. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.MetricNamespaceCollection] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_metric_namespaces_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.MetricNamespaceCollection, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def list_metrics( + self, + test_run_id: str, + body: Optional[_models.MetricRequestPayload] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> Iterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Default value is None. + :type body: ~azure.developer.loadtesting.models.MetricRequestPayload + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An iterator like instance of TimeSeriesElement + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filters": [ + { + "name": "str", # Optional. The dimension name. + "values": [ + "str" # Optional. The dimension values. Maximum + values can be 20. + ] + } + ] + } + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + + @overload + def list_metrics( + self, + test_run_id: str, + body: Optional[JSON] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> Iterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Default value is None. + :type body: JSON + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An iterator like instance of TimeSeriesElement + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + + @overload + def list_metrics( + self, + test_run_id: str, + body: Optional[IO[bytes]] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> Iterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Default value is None. + :type body: IO[bytes] + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An iterator like instance of TimeSeriesElement + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + + @distributed_trace + def list_metrics( + self, + test_run_id: str, + body: Optional[Union[_models.MetricRequestPayload, JSON, IO[bytes]]] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + **kwargs: Any + ) -> Iterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Is one of the following types: MetricRequestPayload, + JSON, IO[bytes] Default value is None. + :type body: ~azure.developer.loadtesting.models.MetricRequestPayload or JSON or IO[bytes] + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :return: An iterator like instance of TimeSeriesElement + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filters": [ + { + "name": "str", # Optional. The dimension name. + "values": [ + "str" # Optional. The dimension values. Maximum + values can be 20. + ] + } + ] + } + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[List[_models.TimeSeriesElement]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_run_list_metrics_request( + test_run_id=test_run_id, + metricname=metricname, + metric_namespace=metric_namespace, + time_interval=time_interval, + aggregation=aggregation, + interval=interval, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.TimeSeriesElement], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def list_test_runs( + self, + *, + orderby: Optional[str] = None, + search: Optional[str] = None, + test_id: Optional[str] = None, + execution_from: Optional[datetime.datetime] = None, + execution_to: Optional[datetime.datetime] = None, + status: Optional[str] = None, + **kwargs: Any + ) -> Iterable["_models.TestRun"]: + # pylint: disable=line-too-long + """Get all test runs for the given filters. + + Get all test runs for the given filters. + + :keyword orderby: Sort on the supported fields in (field asc/desc) format. eg: executedDateTime + asc. Supported fields - executedDateTime. Default value is None. + :paramtype orderby: str + :keyword search: Prefix based, case sensitive search on searchable fields - description, + executedUser. For example, to search for a test run, with description 500 VUs, + the search parameter can be 500. Default value is None. + :paramtype search: str + :keyword test_id: Unique name of an existing load test. Default value is None. + :paramtype test_id: str + :keyword execution_from: Start DateTime(RFC 3339 literal format) of test-run execution time + filter range. Default value is None. + :paramtype execution_from: ~datetime.datetime + :keyword execution_to: End DateTime(RFC 3339 literal format) of test-run execution time filter + range. Default value is None. + :paramtype execution_to: ~datetime.datetime + :keyword status: Comma separated list of test run status. Default value is None. + :paramtype status: str + :return: An iterator like instance of TestRun + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.TestRun] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[List[_models.TestRun]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_run_list_test_runs_request( + orderby=orderby, + search=search, + test_id=test_id, + execution_from=execution_from, + execution_to=execution_to, + status=status, + maxpagesize=maxpagesize, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.TestRun], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def stop_test_run(self, test_run_id: str, **kwargs: Any) -> _models.TestRun: + # pylint: disable=line-too-long + """Stop test run by test run Id. + + Stop test run by test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + _request = build_load_test_run_stop_test_run_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/_patch.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_patch.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_serialization.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_serialization.py new file mode 100644 index 000000000000..2f781d740827 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_serialization.py @@ -0,0 +1,1998 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the ""Software""), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + TypeVar, + MutableMapping, + Type, + List, + Mapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +ModelType = TypeVar("ModelType", bound="Model") +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + + +try: + from datetime import timezone as _FixedOffset # type: ignore +except ImportError: # Python 2.7 + + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds() / 3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node.""" + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls: Type[ModelType], + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> ModelType: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result.update(objects[valuetype]._flatten_subtype(key, objects)) + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + Remove the polymorphic key from the initial data. + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + """ + return key.replace("\\.", ".") + + +class Serializer(object): + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises: SerializationError if serialization fails. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized.update(target_obj.additional_properties) + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises: SerializationError if serialization fails. + :raises: ValueError if data is None + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + elif data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, data.__class__) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param data: Object to be serialized. + :rtype: str + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + else: + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. + :rtype: list, str + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + elif obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises: SerializationError if format invalid + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError: + raise TypeError("Unix time object must be valid Datetime object.") + + +def rest_key_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(List[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key.""" + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + else: + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + else: # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer(object): + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + elif isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None: + return data + try: + attributes = response._attribute_map # type: ignore + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + else: + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param raw_data: Data to be processed. + :param content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param response: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [k for k, v in response._validation.items() if v.get("readonly")] + const = [k for k, v in response._validation.items() if v.get("constant")] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) + + def deserialize_data(self, data, data_type): + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + else: + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :rtype: dict + :raises: TypeError if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :rtype: str, int, float or bool + :raises: TypeError if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + else: + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + elif isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + elif attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + else: + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :rtype: long or int + :raises: ValueError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :rtype: TimeDelta + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :rtype: Date + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :rtype: Datetime + :raises: DeserializationError if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + else: + return date_obj diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_vendor.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_vendor.py new file mode 100644 index 000000000000..1487cc18a180 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_vendor.py @@ -0,0 +1,35 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import LoadTestAdministrationClientConfiguration, LoadTestRunClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import PipelineClient + + from ._serialization import Deserializer, Serializer + + +class LoadTestAdministrationClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "PipelineClient" + _config: LoadTestAdministrationClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" + + +class LoadTestRunClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "PipelineClient" + _config: LoadTestRunClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_version.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_version.py index 010063f9dd93..be71c81bd282 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_version.py +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_version.py @@ -1,6 +1,9 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- -VERSION = "1.0.1" +VERSION = "1.0.0b1" diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/__init__.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/__init__.py index e055e16c9f6a..162a880336d4 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/__init__.py +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/__init__.py @@ -1,9 +1,25 @@ - -# ------------------------------------------------------------------------- +# coding=utf-8 +# -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._client import LoadTestRunClient, LoadTestAdministrationClient -__all__ = ["LoadTestAdministrationClient", "LoadTestRunClient"] +from ._client import LoadTestAdministrationClient +from ._client import LoadTestRunClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "LoadTestAdministrationClient", + "LoadTestRunClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_client.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_client.py index e3ed061bb413..e153219f4f65 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_client.py +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_client.py @@ -1,47 +1,71 @@ -# ------------------------------------------------------------------------- +# coding=utf-8 +# -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- from copy import deepcopy -from typing import Any, Awaitable +from typing import Any, Awaitable, TYPE_CHECKING -from azure.core.credentials_async import AsyncTokenCredential from azure.core import AsyncPipelineClient -from azure.core.rest import HttpRequest, AsyncHttpResponse +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._serialization import Deserializer, Serializer +from ._configuration import LoadTestAdministrationClientConfiguration, LoadTestRunClientConfiguration +from ._operations import LoadTestAdministrationClientOperationsMixin, LoadTestRunClientOperationsMixin + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential -from .._generated.aio._configuration import LoadTestingClientConfiguration -from .._generated._serialization import Deserializer, Serializer -from .._generated.aio.operations import AdministrationOperations, TestRunOperations -class _BaseClient: # pylint: disable=client-accepts-api-version-keyword - """These APIs allow end users to create, view and run load tests using Azure Load Test Service. +class LoadTestAdministrationClient( + LoadTestAdministrationClientOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword + """LoadTestAdministrationClient. - :ivar administration: AdministrationOperations operations - :vartype administration: azure.developer.loadtesting.aio.operations.AdministrationOperations - :ivar test_run: TestRunOperations operations - :vartype test_run: azure.developer.loadtesting.aio.operations.TestRunOperations - :param endpoint: URL to perform data plane API operations on the resource. Required. + :param endpoint: Required. :type endpoint: str :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential - :keyword api_version: Api Version. Default value is "2022-11-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: - _endpoint = "https://{Endpoint}" - self._config = LoadTestingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - self._client = AsyncPipelineClient(base_url=_endpoint, config=self._config, **kwargs) + _endpoint = "https://{endpoint}" + self._config = LoadTestAdministrationClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) self._serialize = Serializer() self._deserialize = Deserializer() self._serialize.client_side_validation = False - super().__init__(self._client, self._config, self._serialize, self._deserialize) - def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]: + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -61,47 +85,96 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHt request_copy = deepcopy(request) path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore async def close(self) -> None: await self._client.close() - async def __aexit__(self, *exc_details) -> None: + async def __aenter__(self) -> "LoadTestAdministrationClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: await self._client.__aexit__(*exc_details) -class LoadTestAdministrationClient(_BaseClient, AdministrationOperations): # pylint: disable=client-accepts-api-version-keyword - """These APIs allow end users to create, view and run load tests using Azure Load Test Service. +class LoadTestRunClient(LoadTestRunClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + """LoadTestRunClient. - :param endpoint: URL to perform data plane API operations on the resource. Required. + :param endpoint: Required. :type endpoint: str :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential - :keyword api_version: Api Version. Default value is "2022-11-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ - async def __aenter__(self) -> "LoadTestAdministrationClient": - await self._client.__aenter__() - return self + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + _endpoint = "https://{endpoint}" + self._config = LoadTestRunClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) -class LoadTestRunClient(_BaseClient, TestRunOperations): # pylint: disable=client-accepts-api-version-keyword - """These APIs allow end users to create, view and run load tests using Azure Load Test Service. + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False - :param endpoint: URL to perform data plane API operations on the resource. Required. - :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Required. - :type credential: ~azure.core.credentials_async.AsyncTokenCredential - :keyword api_version: Api Version. Default value is "2022-11-01". Note that overriding this - default value may result in unsupported behavior. - :paramtype api_version: str - """ + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() async def __aenter__(self) -> "LoadTestRunClient": await self._client.__aenter__() return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_configuration.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_configuration.py new file mode 100644 index 000000000000..087bdb95ca0d --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_configuration.py @@ -0,0 +1,113 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies + +from .._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class LoadTestAdministrationClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for LoadTestAdministrationClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-04-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cnt-prod.loadtesting.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "developer-loadtesting/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AsyncBearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) + + +class LoadTestRunClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for LoadTestRunClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-04-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cnt-prod.loadtesting.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "developer-loadtesting/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AsyncBearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/__init__.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/__init__.py new file mode 100644 index 000000000000..c433bf33381f --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/__init__.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import LoadTestAdministrationClientOperationsMixin +from ._operations import LoadTestRunClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "LoadTestAdministrationClientOperationsMixin", + "LoadTestRunClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/_operations.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/_operations.py new file mode 100644 index 000000000000..670942d5ed67 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/_operations.py @@ -0,0 +1,7948 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import datetime +from io import IOBase +import json +import sys +from typing import Any, AsyncIterable, Callable, Dict, IO, List, Optional, TypeVar, Union, overload +import urllib.parse + +from azure.core.async_paging import AsyncItemPaged, AsyncList +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator import distributed_trace +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._model_base import SdkJSONEncoder, _deserialize +from ..._operations._operations import ( + build_load_test_administration_begin_upload_test_file_request, + build_load_test_administration_create_or_update_app_components_request, + build_load_test_administration_create_or_update_server_metrics_config_request, + build_load_test_administration_create_or_update_test_request, + build_load_test_administration_delete_test_file_request, + build_load_test_administration_delete_test_request, + build_load_test_administration_get_app_components_request, + build_load_test_administration_get_server_metrics_config_request, + build_load_test_administration_get_test_file_request, + build_load_test_administration_get_test_request, + build_load_test_administration_list_test_files_request, + build_load_test_administration_list_tests_request, + build_load_test_run_begin_test_run_request, + build_load_test_run_create_or_update_app_components_request, + build_load_test_run_create_or_update_server_metrics_config_request, + build_load_test_run_delete_test_run_request, + build_load_test_run_get_app_components_request, + build_load_test_run_get_metric_definitions_request, + build_load_test_run_get_metric_namespaces_request, + build_load_test_run_get_server_metrics_config_request, + build_load_test_run_get_test_run_file_request, + build_load_test_run_get_test_run_request, + build_load_test_run_list_metric_dimension_values_request, + build_load_test_run_list_metrics_request, + build_load_test_run_list_test_runs_request, + build_load_test_run_stop_test_run_request, +) +from .._vendor import LoadTestAdministrationClientMixinABC, LoadTestRunClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class LoadTestAdministrationClientOperationsMixin( # pylint: disable=name-too-long + LoadTestAdministrationClientMixinABC +): + @overload + async def create_or_update_test( + self, test_id: str, body: _models.Test, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Required. + :type body: ~azure.developer.loadtesting.models.Test + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + """ + + @overload + async def create_or_update_test( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + """ + + @overload + async def create_or_update_test( + self, test_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + """ + + @distributed_trace_async + async def create_or_update_test( + self, test_id: str, body: Union[_models.Test, JSON, IO[bytes]], **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Is one of the following types: Test, JSON, IO[bytes] + Required. + :type body: ~azure.developer.loadtesting.models.Test or JSON or IO[bytes] + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.Test] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_administration_create_or_update_test_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.Test, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.Test, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_or_update_app_components( + self, + test_id: str, + body: _models.TestAppComponents, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Required. + :type body: ~azure.developer.loadtesting.models.TestAppComponents + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + async def create_or_update_app_components( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + async def create_or_update_app_components( + self, test_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @distributed_trace_async + async def create_or_update_app_components( + self, test_id: str, body: Union[_models.TestAppComponents, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Is one of the following types: TestAppComponents, JSON, + IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestAppComponents or JSON or IO[bytes] + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestAppComponents] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_administration_create_or_update_app_components_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestAppComponents, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_or_update_server_metrics_config( + self, + test_id: str, + body: _models.TestServerMetricConfig, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Required. + :type body: ~azure.developer.loadtesting.models.TestServerMetricConfig + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + async def create_or_update_server_metrics_config( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + async def create_or_update_server_metrics_config( + self, test_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @distributed_trace_async + async def create_or_update_server_metrics_config( + self, test_id: str, body: Union[_models.TestServerMetricConfig, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Is one of the following types: + TestServerMetricConfig, JSON, IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestServerMetricConfig or JSON or IO[bytes] + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestServerMetricConfig] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_administration_create_or_update_server_metrics_config_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestServerMetricConfig, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_app_components(self, test_id: str, **kwargs: Any) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Get associated app component (collection of azure resources) for the given test. + + Get associated app component (collection of azure resources) for the given test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestAppComponents] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_app_components_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_server_metrics_config(self, test_id: str, **kwargs: Any) -> _models.TestServerMetricConfig: + """List server metrics configuration for the given test. + + List server metrics configuration for the given test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestServerMetricConfig] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_server_metrics_config_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_test(self, test_id: str, **kwargs: Any) -> _models.Test: + # pylint: disable=line-too-long + """Get load test details by test Id. + + Get load test details by test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.Test] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_test_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.Test, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_test_file(self, test_id: str, file_name: str, **kwargs: Any) -> _models.TestFileInfo: + # pylint: disable=line-too-long + """Get all the files that are associated with a test. + + Get all the files that are associated with a test. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param file_name: Name of the file. Required. + :type file_name: str + :return: TestFileInfo. The TestFileInfo is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestFileInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation failure error + details. + "validationStatus": "str" # Optional. Validation status of the file. Known + values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestFileInfo] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_test_file_request( + test_id=test_id, + file_name=file_name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestFileInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_test_files(self, test_id: str, **kwargs: Any) -> AsyncIterable["_models.TestFileInfo"]: + # pylint: disable=line-too-long + """Get all test files. + + Get all test files. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: An iterator like instance of TestFileInfo + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.TestFileInfo] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation failure error + details. + "validationStatus": "str" # Optional. Validation status of the file. Known + values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.TestFileInfo]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_administration_list_test_files_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.TestFileInfo], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace + def list_tests( + self, + *, + orderby: Optional[str] = None, + search: Optional[str] = None, + last_modified_start_time: Optional[datetime.datetime] = None, + last_modified_end_time: Optional[datetime.datetime] = None, + **kwargs: Any + ) -> AsyncIterable["_models.Test"]: + # pylint: disable=line-too-long + """Get all load tests by the fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + + Get all load tests by the fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + + :keyword orderby: Sort on the supported fields in (field asc/desc) format. eg: + lastModifiedDateTime asc. Supported fields - lastModifiedDateTime. Default value is None. + :paramtype orderby: str + :keyword search: Prefix based, case sensitive search on searchable fields - displayName, + createdBy. For example, to search for a test, with display name is Login Test, + the search parameter can be Login. Default value is None. + :paramtype search: str + :keyword last_modified_start_time: Start DateTime(RFC 3339 literal format) of the last updated + time range to filter tests. Default value is None. + :paramtype last_modified_start_time: ~datetime.datetime + :keyword last_modified_end_time: End DateTime(RFC 3339 literal format) of the last updated time + range to filter tests. Default value is None. + :paramtype last_modified_end_time: ~datetime.datetime + :return: An iterator like instance of Test + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.Test] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation + failure error details. + "validationStatus": "str" # Optional. Validation status of + the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "subnetId": "str" # Optional. Subnet ID on which the load test instances + should run. + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[List[_models.Test]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_administration_list_tests_request( + orderby=orderby, + search=search, + last_modified_start_time=last_modified_start_time, + last_modified_end_time=last_modified_end_time, + maxpagesize=maxpagesize, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.Test], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + async def begin_upload_test_file( + self, + test_id: str, + file_name: str, + body: bytes, + *, + file_type: Optional[Union[str, _models.FileType]] = None, + **kwargs: Any + ) -> _models.TestFileInfo: + # pylint: disable=line-too-long + """Upload input file for a given test Id. File size can't be more than 50 MB. + Existing file with same name for the given test will be overwritten. File + should be provided in the request body as application/octet-stream. + + Upload input file for a given test Id. File size can't be more than 50 MB. + Existing file with same name for the given test will be overwritten. File + should be provided in the request body as application/octet-stream. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param file_name: Unique name for test file with file extension like : App.jmx. Required. + :type file_name: str + :param body: The file content as application/octet-stream. Required. + :type body: bytes + :keyword file_type: File type. Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". Default value is None. + :paramtype file_type: str or ~azure.developer.loadtesting.models.FileType + :return: TestFileInfo. The TestFileInfo is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestFileInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation failure error + details. + "validationStatus": "str" # Optional. Validation status of the file. Known + values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: str = kwargs.pop("content_type", _headers.pop("content-type", "application/octet-stream")) + cls: ClsType[_models.TestFileInfo] = kwargs.pop("cls", None) + + _content = body + + _request = build_load_test_administration_begin_upload_test_file_request( + test_id=test_id, + file_name=file_name, + file_type=file_type, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestFileInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete_test_file( # pylint: disable=inconsistent-return-statements + self, test_id: str, file_name: str, **kwargs: Any + ) -> None: + """Delete file by the file name for a test. + + Delete file by the file name for a test. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param file_name: Name of the file. Required. + :type file_name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_load_test_administration_delete_test_file_request( + test_id=test_id, + file_name=file_name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def delete_test(self, test_id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete a test by its test Id. + + Delete a test by its test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_load_test_administration_delete_test_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + +class LoadTestRunClientOperationsMixin(LoadTestRunClientMixinABC): + @overload + async def begin_test_run( + self, + test_run_id: str, + body: _models.TestRun, + *, + content_type: str = "application/merge-patch+json", + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Required. + :type body: ~azure.developer.loadtesting.models.TestRun + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + + @overload + async def begin_test_run( + self, + test_run_id: str, + body: JSON, + *, + content_type: str = "application/merge-patch+json", + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + + @overload + async def begin_test_run( + self, + test_run_id: str, + body: IO[bytes], + *, + content_type: str = "application/merge-patch+json", + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + + @distributed_trace_async + async def begin_test_run( + self, + test_run_id: str, + body: Union[_models.TestRun, JSON, IO[bytes]], + *, + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Is one of the following types: TestRun, JSON, IO[bytes] + Required. + :type body: ~azure.developer.loadtesting.models.TestRun or JSON or IO[bytes] + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_run_begin_test_run_request( + test_run_id=test_run_id, + old_test_run_id=old_test_run_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_or_update_app_components( + self, + test_run_id: str, + body: _models.TestRunAppComponents, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Required. + :type body: ~azure.developer.loadtesting.models.TestRunAppComponents + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + async def create_or_update_app_components( + self, test_run_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + async def create_or_update_app_components( + self, test_run_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @distributed_trace_async + async def create_or_update_app_components( + self, test_run_id: str, body: Union[_models.TestRunAppComponents, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Is one of the following types: TestRunAppComponents, JSON, + IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestRunAppComponents or JSON or IO[bytes] + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestRunAppComponents] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_run_create_or_update_app_components_request( + test_run_id=test_run_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunAppComponents, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_or_update_server_metrics_config( + self, + test_run_id: str, + body: _models.TestRunServerMetricConfig, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Required. + :type body: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + async def create_or_update_server_metrics_config( + self, test_run_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + async def create_or_update_server_metrics_config( + self, test_run_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @distributed_trace_async + async def create_or_update_server_metrics_config( + self, test_run_id: str, body: Union[_models.TestRunServerMetricConfig, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Is one of the following types: + TestRunServerMetricConfig, JSON, IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestRunServerMetricConfig or JSON or IO[bytes] + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestRunServerMetricConfig] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_run_create_or_update_server_metrics_config_request( + test_run_id=test_run_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunServerMetricConfig, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete_test_run( # pylint: disable=inconsistent-return-statements + self, test_run_id: str, **kwargs: Any + ) -> None: + """Delete an existing load test run. + + Delete an existing load test run by providing the testRunId. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_load_test_run_delete_test_run_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def get_app_components(self, test_run_id: str, **kwargs: Any) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Get associated app component (collection of azure resources) for the given test + run. + + Get associated app component (collection of azure resources) for the given test + run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRunAppComponents] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_app_components_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_server_metrics_config(self, test_run_id: str, **kwargs: Any) -> _models.TestRunServerMetricConfig: + """Get associated server metrics configuration for the given test run. + + Get associated server metrics configuration for the given test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRunServerMetricConfig] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_server_metrics_config_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_test_run(self, test_run_id: str, **kwargs: Any) -> _models.TestRun: + # pylint: disable=line-too-long + """Get test run details by test run Id. + + Get test run details by test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_test_run_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_test_run_file(self, test_run_id: str, file_name: str, **kwargs: Any) -> _models.TestRunFileInfo: + # pylint: disable=line-too-long + """Get test run file by file name. + + Get test run file by file name. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param file_name: Name of the file. Required. + :type file_name: str + :return: TestRunFileInfo. The TestRunFileInfo is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunFileInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. Validation failure error + details. + "validationStatus": "str" # Optional. Validation status of the file. Known + values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRunFileInfo] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_test_run_file_request( + test_run_id=test_run_id, + file_name=file_name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunFileInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def list_metric_dimension_values( + self, + test_run_id: str, + name: str, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + interval: Optional[Union[str, _models.TimeGrain]] = None, + **kwargs: Any + ) -> _models.DimensionValueList: + """List the dimension values for the given metric dimension name. + + List the dimension values for the given metric dimension name. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param name: Dimension name. Required. + :type name: str + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :return: DimensionValueList. The DimensionValueList is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.DimensionValueList + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "name": "str", # Optional. The dimension name. + "nextLink": "str", # Optional. Link for the next set of values in case of + paginated results, if applicable. + "value": [ + "str" # Optional. The dimension value. + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.DimensionValueList] = kwargs.pop("cls", None) + + _request = build_load_test_run_list_metric_dimension_values_request( + test_run_id=test_run_id, + name=name, + metricname=metricname, + metric_namespace=metric_namespace, + time_interval=time_interval, + interval=interval, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.DimensionValueList, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_metric_definitions( + self, test_run_id: str, *, metric_namespace: str, **kwargs: Any + ) -> _models.MetricDefinitionCollection: + # pylint: disable=line-too-long + """List the metric definitions for a load test run. + + List the metric definitions for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :return: MetricDefinitionCollection. The MetricDefinitionCollection is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.MetricDefinitionCollection + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "description": "str", # Optional. The metric description. + "dimensions": [ + { + "description": "str", # Optional. The + description. + "name": "str" # Optional. The name. + } + ], + "metricAvailabilities": [ + { + "timeGrain": "str" # Optional. The time + grain specifies the aggregation interval for the metric. + Expressed as a duration 'PT1M', 'PT1H', etc. Known values are: + "PT5S", "PT10S", "PT1M", "PT5M", and "PT1H". + } + ], + "name": "str", # Optional. The metric name. + "namespace": "str", # Optional. The namespace the metric + belongs to. + "primaryAggregationType": "str", # Optional. The primary + aggregation type value defining how to use the values for display. Known + values are: "Average", "Count", "None", "Total", "Percentile90", + "Percentile95", and "Percentile99". + "supportedAggregationTypes": [ + "str" # Optional. The collection of what all + aggregation types are supported. + ], + "unit": "str" # Optional. The unit of the metric. Known + values are: "NotSpecified", "Percent", "Count", "Seconds", + "Milliseconds", "Bytes", "BytesPerSecond", and "CountPerSecond". + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.MetricDefinitionCollection] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_metric_definitions_request( + test_run_id=test_run_id, + metric_namespace=metric_namespace, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.MetricDefinitionCollection, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_metric_namespaces(self, test_run_id: str, **kwargs: Any) -> _models.MetricNamespaceCollection: + """List the metric namespaces for a load test run. + + List the metric namespaces for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: MetricNamespaceCollection. The MetricNamespaceCollection is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.MetricNamespaceCollection + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "description": "str", # Optional. The namespace description. + "name": "str" # Optional. The metric namespace name. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.MetricNamespaceCollection] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_metric_namespaces_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.MetricNamespaceCollection, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def list_metrics( + self, + test_run_id: str, + body: Optional[_models.MetricRequestPayload] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncIterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Default value is None. + :type body: ~azure.developer.loadtesting.models.MetricRequestPayload + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An iterator like instance of TimeSeriesElement + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filters": [ + { + "name": "str", # Optional. The dimension name. + "values": [ + "str" # Optional. The dimension values. Maximum + values can be 20. + ] + } + ] + } + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + + @overload + def list_metrics( + self, + test_run_id: str, + body: Optional[JSON] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncIterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Default value is None. + :type body: JSON + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An iterator like instance of TimeSeriesElement + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + + @overload + def list_metrics( + self, + test_run_id: str, + body: Optional[IO[bytes]] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncIterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Default value is None. + :type body: IO[bytes] + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An iterator like instance of TimeSeriesElement + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + + @distributed_trace + def list_metrics( + self, + test_run_id: str, + body: Optional[Union[_models.MetricRequestPayload, JSON, IO[bytes]]] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + **kwargs: Any + ) -> AsyncIterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Is one of the following types: MetricRequestPayload, + JSON, IO[bytes] Default value is None. + :type body: ~azure.developer.loadtesting.models.MetricRequestPayload or JSON or IO[bytes] + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :return: An iterator like instance of TimeSeriesElement + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filters": [ + { + "name": "str", # Optional. The dimension name. + "values": [ + "str" # Optional. The dimension values. Maximum + values can be 20. + ] + } + ] + } + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[List[_models.TimeSeriesElement]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_run_list_metrics_request( + test_run_id=test_run_id, + metricname=metricname, + metric_namespace=metric_namespace, + time_interval=time_interval, + aggregation=aggregation, + interval=interval, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.TimeSeriesElement], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace + def list_test_runs( + self, + *, + orderby: Optional[str] = None, + search: Optional[str] = None, + test_id: Optional[str] = None, + execution_from: Optional[datetime.datetime] = None, + execution_to: Optional[datetime.datetime] = None, + status: Optional[str] = None, + **kwargs: Any + ) -> AsyncIterable["_models.TestRun"]: + # pylint: disable=line-too-long + """Get all test runs for the given filters. + + Get all test runs for the given filters. + + :keyword orderby: Sort on the supported fields in (field asc/desc) format. eg: executedDateTime + asc. Supported fields - executedDateTime. Default value is None. + :paramtype orderby: str + :keyword search: Prefix based, case sensitive search on searchable fields - description, + executedUser. For example, to search for a test run, with description 500 VUs, + the search parameter can be 500. Default value is None. + :paramtype search: str + :keyword test_id: Unique name of an existing load test. Default value is None. + :paramtype test_id: str + :keyword execution_from: Start DateTime(RFC 3339 literal format) of test-run execution time + filter range. Default value is None. + :paramtype execution_from: ~datetime.datetime + :keyword execution_to: End DateTime(RFC 3339 literal format) of test-run execution time filter + range. Default value is None. + :paramtype execution_to: ~datetime.datetime + :keyword status: Comma separated list of test run status. Default value is None. + :paramtype status: str + :return: An iterator like instance of TestRun + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.TestRun] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[List[_models.TestRun]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_run_list_test_runs_request( + orderby=orderby, + search=search, + test_id=test_id, + execution_from=execution_from, + execution_to=execution_to, + status=status, + maxpagesize=maxpagesize, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.TestRun], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + async def stop_test_run(self, test_run_id: str, **kwargs: Any) -> _models.TestRun: + # pylint: disable=line-too-long + """Stop test run by test run Id. + + Stop test run by test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "certificate": { + "name": "str", # Optional. Name of the certificate. + "type": "str", # Optional. Type of certificate. "AKV_CERT_URI" + "value": "str" # Optional. The value of the certificate for + respective type. + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. If false, Azure Load Testing copies + and processes your input files unmodified across all test engine instances. + If true, Azure Load Testing splits the CSV input data evenly across all + engine instances. If you provide multiple CSV files, each file will be split + evenly. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # + Optional. Validation failure error details. + "validationStatus": "str" # Optional. + Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", + "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED". + } + ], + "configFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "inputArtifactsZipFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "testScriptFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "userPropFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + _request = build_load_test_run_stop_test_run_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/_patch.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_patch.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_vendor.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_vendor.py new file mode 100644 index 000000000000..c6ab7b500913 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_vendor.py @@ -0,0 +1,35 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import LoadTestAdministrationClientConfiguration, LoadTestRunClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import AsyncPipelineClient + + from .._serialization import Deserializer, Serializer + + +class LoadTestAdministrationClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "AsyncPipelineClient" + _config: LoadTestAdministrationClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" + + +class LoadTestRunClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "AsyncPipelineClient" + _config: LoadTestRunClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/__init__.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/__init__.py new file mode 100644 index 000000000000..9edc44c39961 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/__init__.py @@ -0,0 +1,117 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import AppComponent +from ._models import ArtifactsContainerInfo +from ._models import AutoStopCriteria +from ._models import CertificateMetadata +from ._models import DimensionFilter +from ._models import DimensionValue +from ._models import DimensionValueList +from ._models import ErrorDetails +from ._models import LoadTestConfiguration +from ._models import MetricAvailability +from ._models import MetricDefinition +from ._models import MetricDefinitionCollection +from ._models import MetricNamespace +from ._models import MetricNamespaceCollection +from ._models import MetricRequestPayload +from ._models import MetricValue +from ._models import NameAndDesc +from ._models import OptionalLoadTestConfig +from ._models import PassFailCriteria +from ._models import PassFailMetric +from ._models import ResourceMetric +from ._models import Secret +from ._models import Test +from ._models import TestAppComponents +from ._models import TestFileInfo +from ._models import TestInputArtifacts +from ._models import TestRun +from ._models import TestRunAppComponents +from ._models import TestRunArtifacts +from ._models import TestRunFileInfo +from ._models import TestRunInputArtifacts +from ._models import TestRunOutputArtifacts +from ._models import TestRunServerMetricConfig +from ._models import TestRunStatistics +from ._models import TestServerMetricConfig +from ._models import TimeSeriesElement + +from ._enums import AggregationType +from ._enums import CertificateType +from ._enums import FileStatus +from ._enums import FileType +from ._enums import MetricUnit +from ._enums import PFAction +from ._enums import PFAgFunc +from ._enums import PFMetrics +from ._enums import PFResult +from ._enums import PFTestResult +from ._enums import SecretType +from ._enums import Status +from ._enums import TestKind +from ._enums import TimeGrain +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "AppComponent", + "ArtifactsContainerInfo", + "AutoStopCriteria", + "CertificateMetadata", + "DimensionFilter", + "DimensionValue", + "DimensionValueList", + "ErrorDetails", + "LoadTestConfiguration", + "MetricAvailability", + "MetricDefinition", + "MetricDefinitionCollection", + "MetricNamespace", + "MetricNamespaceCollection", + "MetricRequestPayload", + "MetricValue", + "NameAndDesc", + "OptionalLoadTestConfig", + "PassFailCriteria", + "PassFailMetric", + "ResourceMetric", + "Secret", + "Test", + "TestAppComponents", + "TestFileInfo", + "TestInputArtifacts", + "TestRun", + "TestRunAppComponents", + "TestRunArtifacts", + "TestRunFileInfo", + "TestRunInputArtifacts", + "TestRunOutputArtifacts", + "TestRunServerMetricConfig", + "TestRunStatistics", + "TestServerMetricConfig", + "TimeSeriesElement", + "AggregationType", + "CertificateType", + "FileStatus", + "FileType", + "MetricUnit", + "PFAction", + "PFAgFunc", + "PFMetrics", + "PFResult", + "PFTestResult", + "SecretType", + "Status", + "TestKind", + "TimeGrain", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_enums.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_enums.py new file mode 100644 index 000000000000..3a5ffef039e2 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_enums.py @@ -0,0 +1,226 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class AggregationType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Aggregation type.""" + + AVERAGE = "Average" + """Average value.""" + COUNT = "Count" + """Total count.""" + NONE = "None" + """Aggregation will be average in this case.""" + TOTAL = "Total" + """Total sum.""" + PERCENTILE90 = "Percentile90" + """90th percentile.""" + PERCENTILE95 = "Percentile95" + """95th percentile.""" + PERCENTILE99 = "Percentile99" + """99th percentile.""" + + +class CertificateType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Types of certificates supported.""" + + AKV_CERT_URI = "AKV_CERT_URI" + """If the certificate is stored in an Azure Key Vault.""" + + +class FileStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """File status.""" + + NOT_VALIDATED = "NOT_VALIDATED" + """File is not validated.""" + VALIDATION_SUCCESS = "VALIDATION_SUCCESS" + """File is validated.""" + VALIDATION_FAILURE = "VALIDATION_FAILURE" + """File validation is failed.""" + VALIDATION_INITIATED = "VALIDATION_INITIATED" + """File validation is in progress.""" + VALIDATION_NOT_REQUIRED = "VALIDATION_NOT_REQUIRED" + """Validation is not required.""" + + +class FileType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Types of file supported.""" + + JMX_FILE = "JMX_FILE" + """If the file is a JMX script.""" + USER_PROPERTIES = "USER_PROPERTIES" + """If the file is a user properties file.""" + ADDITIONAL_ARTIFACTS = "ADDITIONAL_ARTIFACTS" + """If the file is not among any of the other supported file types.""" + ZIPPED_ARTIFACTS = "ZIPPED_ARTIFACTS" + """If the file is a compressed archive containing a collection of various artifacts or resources.""" + URL_TEST_CONFIG_JSON = "URL_TEST_CONFIG_JSON" + """If the file is a JSON config file to define the requests for a URL test.""" + + +class MetricUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Metric unit.""" + + NOT_SPECIFIED = "NotSpecified" + """No unit specified.""" + PERCENT = "Percent" + """Percentage.""" + COUNT = "Count" + """Value count.""" + SECONDS = "Seconds" + """Seconds.""" + MILLISECONDS = "Milliseconds" + """Milliseconds""" + BYTES = "Bytes" + """Bytes""" + BYTES_PER_SECOND = "BytesPerSecond" + """Bytes per second""" + COUNT_PER_SECOND = "CountPerSecond" + """Count per second""" + + +class PFAction(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Action to take on failure of pass/fail criteria.""" + + CONTINUE = "continue" + """Test will continue to run even if pass fail metric criteria metric gets failed.""" + STOP = "stop" + """Test run will stop if pass fail criteria metric is not passed.""" + + +class PFAgFunc(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Aggregation functions for pass/fail criteria.""" + + COUNT = "count" + """Criteria applies for count value.""" + PERCENTAGE = "percentage" + """Criteria applies for given percentage value.""" + AVG = "avg" + """Criteria applies for avg value.""" + P50 = "p50" + """Criteria applies for 50th percentile value.""" + P90 = "p90" + """Criteria applies for 90th percentile value.""" + P95 = "p95" + """Criteria applies for 95th percentile value.""" + P99 = "p99" + """Criteria applies for 99th percentile value.""" + MIN = "min" + """Criteria applies for minimum value.""" + MAX = "max" + """Criteria applies for maximum value.""" + + +class PFMetrics(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Metrics for pass/fail criteria.""" + + RESPONSE_TIME_MS = "response_time_ms" + """Pass fail criteria for response time metric in milliseconds.""" + LATENCY = "latency" + """Pass fail criteria for latency metric in milliseconds.""" + ERROR = "error" + """Pass fail criteria for error metric.""" + REQUESTS = "requests" + """Pass fail criteria for total requests.""" + REQUESTS_PER_SEC = "requests_per_sec" + """Pass fail criteria for request per second.""" + + +class PFResult(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Pass/fail criteria result.""" + + PASSED = "passed" + """Given pass fail criteria metric has passed.""" + UNDETERMINED = "undetermined" + """Given pass fail criteria metric couldn't determine.""" + FAILED = "failed" + """Given pass fail criteria metric has failed.""" + + +class PFTestResult(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Test result based on pass/fail criteria.""" + + PASSED = "PASSED" + """Pass/fail criteria has passed.""" + NOT_APPLICABLE = "NOT_APPLICABLE" + """Pass/fail criteria is not applicable.""" + FAILED = "FAILED" + """Pass/fail criteria has failed.""" + + +class SecretType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Types of secrets supported.""" + + AKV_SECRET_URI = "AKV_SECRET_URI" + """If the secret is stored in an Azure Key Vault.""" + SECRET_VALUE = "SECRET_VALUE" + """If the secret value provided as plain text.""" + + +class Status(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Test run status.""" + + ACCEPTED = "ACCEPTED" + """Test run request is accepted.""" + NOTSTARTED = "NOTSTARTED" + """Test run is not yet started.""" + PROVISIONING = "PROVISIONING" + """Test run is provisioning.""" + PROVISIONED = "PROVISIONED" + """Test run is provisioned.""" + CONFIGURING = "CONFIGURING" + """Test run is getting configured.""" + CONFIGURED = "CONFIGURED" + """Test run configuration is done.""" + EXECUTING = "EXECUTING" + """Test run has started executing.""" + EXECUTED = "EXECUTED" + """Test run execution is completed.""" + DEPROVISIONING = "DEPROVISIONING" + """Test run is getting deprovisioned.""" + DEPROVISIONED = "DEPROVISIONED" + """Test run is deprovisioned.""" + DONE = "DONE" + """Test run is completed.""" + CANCELLING = "CANCELLING" + """Test run is being cancelled.""" + CANCELLED = "CANCELLED" + """Test run request is cancelled.""" + FAILED = "FAILED" + """Test run request is failed.""" + VALIDATION_SUCCESS = "VALIDATION_SUCCESS" + """Test run JMX file is validated.""" + VALIDATION_FAILURE = "VALIDATION_FAILURE" + """Test run JMX file validation is failed.""" + + +class TestKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Test kind.""" + + URL = "URL" + """URL Test""" + JMX = "JMX" + """JMX Test""" + + +class TimeGrain(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Time Grain.""" + + PT5S = "PT5S" + """5 seconds, available only if test run duration is less than 10 minutes.""" + PT10S = "PT10S" + """10 seconds, available only if test run duration is less than 10 minutes.""" + PT1M = "PT1M" + """1 minute""" + PT5M = "PT5M" + """5 minutes, available only if test run duration is greater than 1 minute.""" + PT1H = "PT1H" + """1 hour, available only if test run duration is greater than 1 minute.""" diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_models.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_models.py new file mode 100644 index 000000000000..1a7f6ae55f60 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_models.py @@ -0,0 +1,1934 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +import datetime +from typing import Any, Dict, List, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .. import _model_base +from .._model_base import rest_field + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from .. import models as _models + + +class AppComponent(_model_base.Model): + """An Azure resource object (Refer azure generic resource model + :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource). + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar resource_id: fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + :vartype resource_id: str + :ivar resource_name: Azure resource name, required while creating the app component. Required. + :vartype resource_name: str + :ivar resource_type: Azure resource type, required while creating the app component. Required. + :vartype resource_type: str + :ivar display_name: Azure resource display name. + :vartype display_name: str + :ivar resource_group: Resource group name of the Azure resource. + :vartype resource_group: str + :ivar subscription_id: Subscription Id of the Azure resource. + :vartype subscription_id: str + :ivar kind: Kind of Azure resource type. + :vartype kind: str + """ + + resource_id: str = rest_field(name="resourceId", visibility=["read"]) + """fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required.""" + resource_name: str = rest_field(name="resourceName") + """Azure resource name, required while creating the app component. Required.""" + resource_type: str = rest_field(name="resourceType") + """Azure resource type, required while creating the app component. Required.""" + display_name: Optional[str] = rest_field(name="displayName") + """Azure resource display name.""" + resource_group: Optional[str] = rest_field(name="resourceGroup", visibility=["read"]) + """Resource group name of the Azure resource.""" + subscription_id: Optional[str] = rest_field(name="subscriptionId", visibility=["read"]) + """Subscription Id of the Azure resource.""" + kind: Optional[str] = rest_field() + """Kind of Azure resource type.""" + + @overload + def __init__( + self, + *, + resource_name: str, + resource_type: str, + display_name: Optional[str] = None, + kind: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ArtifactsContainerInfo(_model_base.Model): + """Artifacts container info. + + :ivar url: This is a SAS URI to an Azure Storage Container that contains the test run + artifacts. + :vartype url: str + :ivar expire_date_time: Expiry time of the container (RFC 3339 literal format). + :vartype expire_date_time: ~datetime.datetime + """ + + url: Optional[str] = rest_field() + """This is a SAS URI to an Azure Storage Container that contains the test run artifacts.""" + expire_date_time: Optional[datetime.datetime] = rest_field(name="expireDateTime", format="rfc3339") + """Expiry time of the container (RFC 3339 literal format).""" + + @overload + def __init__( + self, + *, + url: Optional[str] = None, + expire_date_time: Optional[datetime.datetime] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AutoStopCriteria(_model_base.Model): + """Auto stop criteria for a test. This will automatically stop a load test if the error percentage + is high for a certain time window. + + :ivar auto_stop_disabled: Whether auto-stop should be disabled. The default value is false. + :vartype auto_stop_disabled: bool + :ivar error_rate: Threshold percentage of errors on which test run should be automatically + stopped. Allowed values are in range of 0.0-100.0. + :vartype error_rate: float + :ivar error_rate_time_window_in_seconds: Time window during which the error percentage should + be evaluated in seconds. + :vartype error_rate_time_window_in_seconds: int + """ + + auto_stop_disabled: Optional[bool] = rest_field(name="autoStopDisabled") + """Whether auto-stop should be disabled. The default value is false.""" + error_rate: Optional[float] = rest_field(name="errorRate") + """Threshold percentage of errors on which test run should be automatically stopped. Allowed + values are in range of 0.0-100.0.""" + error_rate_time_window_in_seconds: Optional[int] = rest_field(name="errorRateTimeWindowInSeconds") + """Time window during which the error percentage should be evaluated in seconds.""" + + @overload + def __init__( + self, + *, + auto_stop_disabled: Optional[bool] = None, + error_rate: Optional[float] = None, + error_rate_time_window_in_seconds: Optional[int] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CertificateMetadata(_model_base.Model): + """Certificates metadata. + + :ivar value: The value of the certificate for respective type. + :vartype value: str + :ivar type: Type of certificate. "AKV_CERT_URI" + :vartype type: str or ~azure.developer.loadtesting.models.CertificateType + :ivar name: Name of the certificate. + :vartype name: str + """ + + value: Optional[str] = rest_field() + """The value of the certificate for respective type.""" + type: Optional[Union[str, "_models.CertificateType"]] = rest_field() + """Type of certificate. \"AKV_CERT_URI\"""" + name: Optional[str] = rest_field() + """Name of the certificate.""" + + @overload + def __init__( + self, + *, + value: Optional[str] = None, + type: Optional[Union[str, "_models.CertificateType"]] = None, + name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DimensionFilter(_model_base.Model): + """Dimension name and values to filter. + + :ivar name: The dimension name. + :vartype name: str + :ivar values_property: The dimension values. Maximum values can be 20. + :vartype values_property: list[str] + """ + + name: Optional[str] = rest_field() + """The dimension name.""" + values_property: Optional[List[str]] = rest_field(name="values") + """The dimension values. Maximum values can be 20.""" + + @overload + def __init__( + self, + *, + name: Optional[str] = None, + values_property: Optional[List[str]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DimensionValue(_model_base.Model): + """Represents a metric dimension value. + + :ivar name: The name of the dimension. + :vartype name: str + :ivar value: The value of the dimension. + :vartype value: str + """ + + name: Optional[str] = rest_field() + """The name of the dimension.""" + value: Optional[str] = rest_field() + """The value of the dimension.""" + + @overload + def __init__( + self, + *, + name: Optional[str] = None, + value: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DimensionValueList(_model_base.Model): + """Metrics dimension values. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar name: The dimension name. + :vartype name: str + :ivar value: The dimension value. + :vartype value: list[str] + :ivar next_link: Link for the next set of values in case of paginated results, if applicable. + :vartype next_link: str + """ + + name: Optional[str] = rest_field(visibility=["read"]) + """The dimension name.""" + value: Optional[List[str]] = rest_field() + """The dimension value.""" + next_link: Optional[str] = rest_field(name="nextLink") + """Link for the next set of values in case of paginated results, if applicable.""" + + @overload + def __init__( + self, + *, + value: Optional[List[str]] = None, + next_link: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ErrorDetails(_model_base.Model): + """Error details if there is any failure in load test run. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar message: Error details in case test run was not successfully run. + :vartype message: str + """ + + message: Optional[str] = rest_field(visibility=["read"]) + """Error details in case test run was not successfully run.""" + + +class LoadTestConfiguration(_model_base.Model): + """Configurations for the load test. + + :ivar engine_instances: The number of engine instances to execute load test. Supported values + are in range of 1-400. Required for creating a new test. + :vartype engine_instances: int + :ivar split_all_c_s_vs: If false, Azure Load Testing copies and processes your input files + unmodified + across all test engine instances. If true, Azure Load Testing splits the CSV + input data evenly across all engine instances. If you provide multiple CSV + files, each file will be split evenly. + :vartype split_all_c_s_vs: bool + :ivar quick_start_test: If true, optionalLoadTestConfig is required and JMX script for the load + test is + not required to upload. + :vartype quick_start_test: bool + :ivar optional_load_test_config: Configuration for quick load test. + :vartype optional_load_test_config: ~azure.developer.loadtesting.models.OptionalLoadTestConfig + """ + + engine_instances: Optional[int] = rest_field(name="engineInstances") + """The number of engine instances to execute load test. Supported values are in range of 1-400. + Required for creating a new test.""" + split_all_c_s_vs: Optional[bool] = rest_field(name="splitAllCSVs") + """If false, Azure Load Testing copies and processes your input files unmodified + across all test engine instances. If true, Azure Load Testing splits the CSV + input data evenly across all engine instances. If you provide multiple CSV + files, each file will be split evenly.""" + quick_start_test: Optional[bool] = rest_field(name="quickStartTest") + """If true, optionalLoadTestConfig is required and JMX script for the load test is + not required to upload.""" + optional_load_test_config: Optional["_models.OptionalLoadTestConfig"] = rest_field(name="optionalLoadTestConfig") + """Configuration for quick load test.""" + + @overload + def __init__( + self, + *, + engine_instances: Optional[int] = None, + split_all_c_s_vs: Optional[bool] = None, + quick_start_test: Optional[bool] = None, + optional_load_test_config: Optional["_models.OptionalLoadTestConfig"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricAvailability(_model_base.Model): + """Metric availability specifies the time grain (aggregation interval or frequency). + + :ivar time_grain: The time grain specifies the aggregation interval for the metric. Expressed + as + a duration 'PT1M', 'PT1H', etc. Known values are: "PT5S", "PT10S", "PT1M", "PT5M", and "PT1H". + :vartype time_grain: str or ~azure.developer.loadtesting.models.TimeGrain + """ + + time_grain: Optional[Union[str, "_models.TimeGrain"]] = rest_field(name="timeGrain") + """The time grain specifies the aggregation interval for the metric. Expressed as + a duration 'PT1M', 'PT1H', etc. Known values are: \"PT5S\", \"PT10S\", \"PT1M\", \"PT5M\", and + \"PT1H\".""" + + @overload + def __init__( + self, + *, + time_grain: Optional[Union[str, "_models.TimeGrain"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricDefinition(_model_base.Model): + """Metric definition. + + :ivar dimensions: List of dimensions. + :vartype dimensions: list[~azure.developer.loadtesting.models.NameAndDesc] + :ivar description: The metric description. + :vartype description: str + :ivar name: The metric name. + :vartype name: str + :ivar namespace: The namespace the metric belongs to. + :vartype namespace: str + :ivar primary_aggregation_type: The primary aggregation type value defining how to use the + values for display. Known values are: "Average", "Count", "None", "Total", "Percentile90", + "Percentile95", and "Percentile99". + :vartype primary_aggregation_type: str or ~azure.developer.loadtesting.models.AggregationType + :ivar supported_aggregation_types: The collection of what all aggregation types are supported. + :vartype supported_aggregation_types: list[str] + :ivar unit: The unit of the metric. Known values are: "NotSpecified", "Percent", "Count", + "Seconds", "Milliseconds", "Bytes", "BytesPerSecond", and "CountPerSecond". + :vartype unit: str or ~azure.developer.loadtesting.models.MetricUnit + :ivar metric_availabilities: Metric availability specifies the time grain (aggregation interval + or + frequency). + :vartype metric_availabilities: list[~azure.developer.loadtesting.models.MetricAvailability] + """ + + dimensions: Optional[List["_models.NameAndDesc"]] = rest_field() + """List of dimensions.""" + description: Optional[str] = rest_field() + """The metric description.""" + name: Optional[str] = rest_field() + """The metric name.""" + namespace: Optional[str] = rest_field() + """The namespace the metric belongs to.""" + primary_aggregation_type: Optional[Union[str, "_models.AggregationType"]] = rest_field( + name="primaryAggregationType" + ) + """The primary aggregation type value defining how to use the values for display. Known values + are: \"Average\", \"Count\", \"None\", \"Total\", \"Percentile90\", \"Percentile95\", and + \"Percentile99\".""" + supported_aggregation_types: Optional[List[str]] = rest_field(name="supportedAggregationTypes") + """The collection of what all aggregation types are supported.""" + unit: Optional[Union[str, "_models.MetricUnit"]] = rest_field() + """The unit of the metric. Known values are: \"NotSpecified\", \"Percent\", \"Count\", + \"Seconds\", \"Milliseconds\", \"Bytes\", \"BytesPerSecond\", and \"CountPerSecond\".""" + metric_availabilities: Optional[List["_models.MetricAvailability"]] = rest_field(name="metricAvailabilities") + """Metric availability specifies the time grain (aggregation interval or + frequency).""" + + @overload + def __init__( + self, + *, + dimensions: Optional[List["_models.NameAndDesc"]] = None, + description: Optional[str] = None, + name: Optional[str] = None, + namespace: Optional[str] = None, + primary_aggregation_type: Optional[Union[str, "_models.AggregationType"]] = None, + supported_aggregation_types: Optional[List[str]] = None, + unit: Optional[Union[str, "_models.MetricUnit"]] = None, + metric_availabilities: Optional[List["_models.MetricAvailability"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricDefinitionCollection(_model_base.Model): + """Represents collection of metric definitions. + + All required parameters must be populated in order to send to server. + + :ivar value: the values for the metric definitions. Required. + :vartype value: list[~azure.developer.loadtesting.models.MetricDefinition] + """ + + value: List["_models.MetricDefinition"] = rest_field() + """the values for the metric definitions. Required.""" + + @overload + def __init__( + self, + *, + value: List["_models.MetricDefinition"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricNamespace(_model_base.Model): + """Metric namespace class specifies the metadata for a metric namespace. + + :ivar description: The namespace description. + :vartype description: str + :ivar name: The metric namespace name. + :vartype name: str + """ + + description: Optional[str] = rest_field() + """The namespace description.""" + name: Optional[str] = rest_field() + """The metric namespace name.""" + + @overload + def __init__( + self, + *, + description: Optional[str] = None, + name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricNamespaceCollection(_model_base.Model): + """Represents collection of metric namespaces. + + All required parameters must be populated in order to send to server. + + :ivar value: The values for the metric namespaces. Required. + :vartype value: list[~azure.developer.loadtesting.models.MetricNamespace] + """ + + value: List["_models.MetricNamespace"] = rest_field() + """The values for the metric namespaces. Required.""" + + @overload + def __init__( + self, + *, + value: List["_models.MetricNamespace"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricRequestPayload(_model_base.Model): + """Filters to fetch the set of metric. + + :ivar filters: Get metrics for specific dimension values. Example: Metric contains dimension + like SamplerName, Error. To retrieve all the time series data where SamplerName + is equals to HTTPRequest1 or HTTPRequest2, the DimensionFilter value will be + {"SamplerName", ["HTTPRequest1", "HTTPRequest2"}. + :vartype filters: list[~azure.developer.loadtesting.models.DimensionFilter] + """ + + filters: Optional[List["_models.DimensionFilter"]] = rest_field() + """Get metrics for specific dimension values. Example: Metric contains dimension + like SamplerName, Error. To retrieve all the time series data where SamplerName + is equals to HTTPRequest1 or HTTPRequest2, the DimensionFilter value will be + {\"SamplerName\", [\"HTTPRequest1\", \"HTTPRequest2\"}.""" + + @overload + def __init__( + self, + *, + filters: Optional[List["_models.DimensionFilter"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricValue(_model_base.Model): + """Represents a metric value. + + :ivar timestamp: The timestamp for the metric value in RFC 3339 format. + :vartype timestamp: ~datetime.datetime + :ivar value: The metric value. + :vartype value: float + """ + + timestamp: Optional[datetime.datetime] = rest_field(format="rfc3339") + """The timestamp for the metric value in RFC 3339 format.""" + value: Optional[float] = rest_field() + """The metric value.""" + + @overload + def __init__( + self, + *, + timestamp: Optional[datetime.datetime] = None, + value: Optional[float] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class NameAndDesc(_model_base.Model): + """The name and description. + + :ivar description: The description. + :vartype description: str + :ivar name: The name. + :vartype name: str + """ + + description: Optional[str] = rest_field() + """The description.""" + name: Optional[str] = rest_field() + """The name.""" + + @overload + def __init__( + self, + *, + description: Optional[str] = None, + name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OptionalLoadTestConfig(_model_base.Model): + """Configuration for quick load test. + + :ivar endpoint_url: Test URL. Provide the complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + :vartype endpoint_url: str + :ivar requests_per_second: Target throughput (requests per second). This may not be necessarily + achieved. The actual throughput will be lower if the application is not capable of handling it. + :vartype requests_per_second: int + :ivar max_response_time_in_ms: Maximum response time in milliseconds of the API/endpoint. + :vartype max_response_time_in_ms: int + :ivar virtual_users: No of concurrent virtual users. + :vartype virtual_users: int + :ivar ramp_up_time: Ramp up time in seconds. + :vartype ramp_up_time: int + :ivar duration: Test run duration in seconds. + :vartype duration: int + """ + + endpoint_url: Optional[str] = rest_field(name="endpointUrl") + """Test URL. Provide the complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login.""" + requests_per_second: Optional[int] = rest_field(name="requestsPerSecond") + """Target throughput (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling it.""" + max_response_time_in_ms: Optional[int] = rest_field(name="maxResponseTimeInMs") + """Maximum response time in milliseconds of the API/endpoint.""" + virtual_users: Optional[int] = rest_field(name="virtualUsers") + """No of concurrent virtual users.""" + ramp_up_time: Optional[int] = rest_field(name="rampUpTime") + """Ramp up time in seconds.""" + duration: Optional[int] = rest_field() + """Test run duration in seconds.""" + + @overload + def __init__( + self, + *, + endpoint_url: Optional[str] = None, + requests_per_second: Optional[int] = None, + max_response_time_in_ms: Optional[int] = None, + virtual_users: Optional[int] = None, + ramp_up_time: Optional[int] = None, + duration: Optional[int] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PassFailCriteria(_model_base.Model): + """Pass fail criteria for a test. + + :ivar pass_fail_metrics: Map of id and pass fail metrics { id : pass fail metrics }. + :vartype pass_fail_metrics: dict[str, ~azure.developer.loadtesting.models.PassFailMetric] + """ + + pass_fail_metrics: Optional[Dict[str, "_models.PassFailMetric"]] = rest_field(name="passFailMetrics") + """Map of id and pass fail metrics { id : pass fail metrics }.""" + + @overload + def __init__( + self, + *, + pass_fail_metrics: Optional[Dict[str, "_models.PassFailMetric"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PassFailMetric(_model_base.Model): + """Pass fail metric. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar client_metric: The client metric on which the criteria should be applied. Known values + are: "response_time_ms", "latency", "error", "requests", and "requests_per_sec". + :vartype client_metric: str or ~azure.developer.loadtesting.models.PFMetrics + :ivar aggregate: The aggregation function to be applied on the client metric. Allowed functions + + + * ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’, + ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, + ‘count’ - for requests. Known values are: "count", "percentage", "avg", "p50", "p90", "p95", + "p99", "min", and "max". + :vartype aggregate: str or ~azure.developer.loadtesting.models.PFAgFunc + :ivar condition: The comparison operator. Supported types ‘>’, ‘<’. + :vartype condition: str + :ivar request_name: Request name for which the Pass fail criteria has to be applied. + :vartype request_name: str + :ivar value: The value to compare with the client metric. Allowed values - ‘error : [0.0 , + 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms. + :vartype value: float + :ivar action: Action taken after the threshold is met. Default is ‘continue’. Known values are: + "continue" and "stop". + :vartype action: str or ~azure.developer.loadtesting.models.PFAction + :ivar actual_value: The actual value of the client metric for the test run. + :vartype actual_value: float + :ivar result: Outcome of the test run. Known values are: "passed", "undetermined", and + "failed". + :vartype result: str or ~azure.developer.loadtesting.models.PFResult + """ + + client_metric: Optional[Union[str, "_models.PFMetrics"]] = rest_field(name="clientMetric") + """The client metric on which the criteria should be applied. Known values are: + \"response_time_ms\", \"latency\", \"error\", \"requests\", and \"requests_per_sec\".""" + aggregate: Optional[Union[str, "_models.PFAgFunc"]] = rest_field() + """The aggregation function to be applied on the client metric. Allowed functions + + + * ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’, + ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, + ‘count’ - for requests. Known values are: \"count\", \"percentage\", \"avg\", \"p50\", + \"p90\", \"p95\", \"p99\", \"min\", and \"max\".""" + condition: Optional[str] = rest_field() + """The comparison operator. Supported types ‘>’, ‘<’.""" + request_name: Optional[str] = rest_field(name="requestName") + """Request name for which the Pass fail criteria has to be applied.""" + value: Optional[float] = rest_field() + """The value to compare with the client metric. Allowed values - ‘error : [0.0 , + 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms.""" + action: Optional[Union[str, "_models.PFAction"]] = rest_field() + """Action taken after the threshold is met. Default is ‘continue’. Known values are: \"continue\" + and \"stop\".""" + actual_value: Optional[float] = rest_field(name="actualValue", visibility=["read"]) + """The actual value of the client metric for the test run.""" + result: Optional[Union[str, "_models.PFResult"]] = rest_field(visibility=["read"]) + """Outcome of the test run. Known values are: \"passed\", \"undetermined\", and \"failed\".""" + + @overload + def __init__( + self, + *, + client_metric: Optional[Union[str, "_models.PFMetrics"]] = None, + aggregate: Optional[Union[str, "_models.PFAgFunc"]] = None, + condition: Optional[str] = None, + request_name: Optional[str] = None, + value: Optional[float] = None, + action: Optional[Union[str, "_models.PFAction"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResourceMetric(_model_base.Model): + """Associated metric definition for particular metrics of the azure resource ( + Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique name for metric. + :vartype id: str + :ivar resource_id: Azure resource id. Required. + :vartype resource_id: str + :ivar metric_namespace: Metric name space. Required. + :vartype metric_namespace: str + :ivar display_description: Metric description. + :vartype display_description: str + :ivar name: The invariant value of metric name. Required. + :vartype name: str + :ivar aggregation: Metric aggregation. Required. + :vartype aggregation: str + :ivar unit: Metric unit. + :vartype unit: str + :ivar resource_type: Azure resource type. Required. + :vartype resource_type: str + """ + + id: Optional[str] = rest_field(visibility=["read"]) + """Unique name for metric.""" + resource_id: str = rest_field(name="resourceId") + """Azure resource id. Required.""" + metric_namespace: str = rest_field(name="metricNamespace") + """Metric name space. Required.""" + display_description: Optional[str] = rest_field(name="displayDescription") + """Metric description.""" + name: str = rest_field() + """The invariant value of metric name. Required.""" + aggregation: str = rest_field() + """Metric aggregation. Required.""" + unit: Optional[str] = rest_field() + """Metric unit.""" + resource_type: str = rest_field(name="resourceType") + """Azure resource type. Required.""" + + @overload + def __init__( + self, + *, + resource_id: str, + metric_namespace: str, + name: str, + aggregation: str, + resource_type: str, + display_description: Optional[str] = None, + unit: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Secret(_model_base.Model): + """Secret. + + :ivar value: The value of the secret for the respective type. + :vartype value: str + :ivar type: Type of secret. Known values are: "AKV_SECRET_URI" and "SECRET_VALUE". + :vartype type: str or ~azure.developer.loadtesting.models.SecretType + """ + + value: Optional[str] = rest_field() + """The value of the secret for the respective type.""" + type: Optional[Union[str, "_models.SecretType"]] = rest_field() + """Type of secret. Known values are: \"AKV_SECRET_URI\" and \"SECRET_VALUE\".""" + + @overload + def __init__( + self, + *, + value: Optional[str] = None, + type: Optional[Union[str, "_models.SecretType"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Test(_model_base.Model): # pylint: disable=too-many-instance-attributes + """Load test model. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar pass_fail_criteria: Pass fail criteria for a test. + :vartype pass_fail_criteria: ~azure.developer.loadtesting.models.PassFailCriteria + :ivar auto_stop_criteria: Auto stop criteria for a test. This will automatically stop a load + test if the error percentage is high for a certain time window. + :vartype auto_stop_criteria: ~azure.developer.loadtesting.models.AutoStopCriteria + :ivar secrets: Secrets can be stored in an Azure Key Vault or any other secret store. If the + secret is stored in an Azure Key Vault, the value should be the secret + identifier and the type should be AKV_SECRET_URI. If the secret is stored + elsewhere, the secret value should be provided directly and the type should be + SECRET_VALUE. + :vartype secrets: dict[str, ~azure.developer.loadtesting.models.Secret] + :ivar certificate: Certificates metadata. + :vartype certificate: ~azure.developer.loadtesting.models.CertificateMetadata + :ivar environment_variables: Environment variables which are defined as a set of + pairs. + :vartype environment_variables: dict[str, str] + :ivar load_test_configuration: The load test configuration. + :vartype load_test_configuration: ~azure.developer.loadtesting.models.LoadTestConfiguration + :ivar baseline_test_run_id: Id of the test run to be marked as baseline to view trends of + client-side metrics from recent test runs. + :vartype baseline_test_run_id: str + :ivar input_artifacts: The input artifacts for the test. + :vartype input_artifacts: ~azure.developer.loadtesting.models.TestInputArtifacts + :ivar test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :vartype test_id: str + :ivar description: The test description. + :vartype description: str + :ivar display_name: Display name of a test. + :vartype display_name: str + :ivar subnet_id: Subnet ID on which the load test instances should run. + :vartype subnet_id: str + :ivar kind: Kind of test. Known values are: "URL" and "JMX". + :vartype kind: str or ~azure.developer.loadtesting.models.TestKind + :ivar public_i_p_disabled: Inject load test engines without deploying public IP for outbound + access. + :vartype public_i_p_disabled: bool + :ivar keyvault_reference_identity_type: Type of the managed identity referencing the Key vault. + :vartype keyvault_reference_identity_type: str + :ivar keyvault_reference_identity_id: Resource Id of the managed identity referencing the Key + vault. + :vartype keyvault_reference_identity_id: str + :ivar created_date_time: The creation datetime(RFC 3339 literal format). + :vartype created_date_time: ~datetime.datetime + :ivar created_by: The user that created. + :vartype created_by: str + :ivar last_modified_date_time: The last Modified datetime(RFC 3339 literal format). + :vartype last_modified_date_time: ~datetime.datetime + :ivar last_modified_by: The user that last modified. + :vartype last_modified_by: str + """ + + pass_fail_criteria: Optional["_models.PassFailCriteria"] = rest_field(name="passFailCriteria") + """Pass fail criteria for a test.""" + auto_stop_criteria: Optional["_models.AutoStopCriteria"] = rest_field(name="autoStopCriteria") + """Auto stop criteria for a test. This will automatically stop a load test if the error percentage + is high for a certain time window.""" + secrets: Optional[Dict[str, "_models.Secret"]] = rest_field() + """Secrets can be stored in an Azure Key Vault or any other secret store. If the + secret is stored in an Azure Key Vault, the value should be the secret + identifier and the type should be AKV_SECRET_URI. If the secret is stored + elsewhere, the secret value should be provided directly and the type should be + SECRET_VALUE.""" + certificate: Optional["_models.CertificateMetadata"] = rest_field() + """Certificates metadata.""" + environment_variables: Optional[Dict[str, str]] = rest_field(name="environmentVariables") + """Environment variables which are defined as a set of pairs.""" + load_test_configuration: Optional["_models.LoadTestConfiguration"] = rest_field(name="loadTestConfiguration") + """The load test configuration.""" + baseline_test_run_id: Optional[str] = rest_field(name="baselineTestRunId") + """Id of the test run to be marked as baseline to view trends of client-side metrics from recent + test runs.""" + input_artifacts: Optional["_models.TestInputArtifacts"] = rest_field(name="inputArtifacts", visibility=["read"]) + """The input artifacts for the test.""" + test_id: str = rest_field(name="testId", visibility=["read"]) + """Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, + underscore or hyphen characters. Required.""" + description: Optional[str] = rest_field() + """The test description.""" + display_name: Optional[str] = rest_field(name="displayName") + """Display name of a test.""" + subnet_id: Optional[str] = rest_field(name="subnetId") + """Subnet ID on which the load test instances should run.""" + kind: Optional[Union[str, "_models.TestKind"]] = rest_field() + """Kind of test. Known values are: \"URL\" and \"JMX\".""" + public_i_p_disabled: Optional[bool] = rest_field(name="publicIPDisabled") + """Inject load test engines without deploying public IP for outbound access.""" + keyvault_reference_identity_type: Optional[str] = rest_field(name="keyvaultReferenceIdentityType") + """Type of the managed identity referencing the Key vault.""" + keyvault_reference_identity_id: Optional[str] = rest_field(name="keyvaultReferenceIdentityId") + """Resource Id of the managed identity referencing the Key vault.""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The creation datetime(RFC 3339 literal format).""" + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The user that created.""" + last_modified_date_time: Optional[datetime.datetime] = rest_field( + name="lastModifiedDateTime", visibility=["read"], format="rfc3339" + ) + """The last Modified datetime(RFC 3339 literal format).""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The user that last modified.""" + + @overload + def __init__( + self, + *, + pass_fail_criteria: Optional["_models.PassFailCriteria"] = None, + auto_stop_criteria: Optional["_models.AutoStopCriteria"] = None, + secrets: Optional[Dict[str, "_models.Secret"]] = None, + certificate: Optional["_models.CertificateMetadata"] = None, + environment_variables: Optional[Dict[str, str]] = None, + load_test_configuration: Optional["_models.LoadTestConfiguration"] = None, + baseline_test_run_id: Optional[str] = None, + description: Optional[str] = None, + display_name: Optional[str] = None, + subnet_id: Optional[str] = None, + kind: Optional[Union[str, "_models.TestKind"]] = None, + public_i_p_disabled: Optional[bool] = None, + keyvault_reference_identity_type: Optional[str] = None, + keyvault_reference_identity_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestAppComponents(_model_base.Model): + """Test app components. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar components: Azure resource collection { resource id (fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) + : resource object }. Required. + :vartype components: dict[str, ~azure.developer.loadtesting.models.AppComponent] + :ivar test_id: Test identifier. + :vartype test_id: str + :ivar created_date_time: The creation datetime(RFC 3339 literal format). + :vartype created_date_time: ~datetime.datetime + :ivar created_by: The user that created. + :vartype created_by: str + :ivar last_modified_date_time: The last Modified datetime(RFC 3339 literal format). + :vartype last_modified_date_time: ~datetime.datetime + :ivar last_modified_by: The user that last modified. + :vartype last_modified_by: str + """ + + components: Dict[str, "_models.AppComponent"] = rest_field() + """Azure resource collection { resource id (fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) + : resource object }. Required.""" + test_id: Optional[str] = rest_field(name="testId", visibility=["read"]) + """Test identifier.""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The creation datetime(RFC 3339 literal format).""" + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The user that created.""" + last_modified_date_time: Optional[datetime.datetime] = rest_field( + name="lastModifiedDateTime", visibility=["read"], format="rfc3339" + ) + """The last Modified datetime(RFC 3339 literal format).""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The user that last modified.""" + + @overload + def __init__( + self, + *, + components: Dict[str, "_models.AppComponent"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestFileInfo(_model_base.Model): + """Test file info. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar file_name: Name of the file. Required. + :vartype file_name: str + :ivar url: File URL. + :vartype url: str + :ivar file_type: File type. Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + :vartype file_type: str or ~azure.developer.loadtesting.models.FileType + :ivar expire_date_time: Expiry time of the file (RFC 3339 literal format). + :vartype expire_date_time: ~datetime.datetime + :ivar validation_status: Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + :vartype validation_status: str or ~azure.developer.loadtesting.models.FileStatus + :ivar validation_failure_details: Validation failure error details. + :vartype validation_failure_details: str + """ + + file_name: str = rest_field(name="fileName") + """Name of the file. Required.""" + url: Optional[str] = rest_field(visibility=["read"]) + """File URL.""" + file_type: Optional[Union[str, "_models.FileType"]] = rest_field(name="fileType", visibility=["read"]) + """File type. Known values are: \"JMX_FILE\", \"USER_PROPERTIES\", \"ADDITIONAL_ARTIFACTS\", + \"ZIPPED_ARTIFACTS\", and \"URL_TEST_CONFIG_JSON\".""" + expire_date_time: Optional[datetime.datetime] = rest_field( + name="expireDateTime", visibility=["read"], format="rfc3339" + ) + """Expiry time of the file (RFC 3339 literal format).""" + validation_status: Optional[Union[str, "_models.FileStatus"]] = rest_field( + name="validationStatus", visibility=["read"] + ) + """Validation status of the file. Known values are: \"NOT_VALIDATED\", \"VALIDATION_SUCCESS\", + \"VALIDATION_FAILURE\", \"VALIDATION_INITIATED\", and \"VALIDATION_NOT_REQUIRED\".""" + validation_failure_details: Optional[str] = rest_field(name="validationFailureDetails", visibility=["read"]) + """Validation failure error details.""" + + @overload + def __init__( + self, + *, + file_name: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestInputArtifacts(_model_base.Model): + """The input artifacts for the test. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar config_file_info: File info. + :vartype config_file_info: ~azure.developer.loadtesting.models.TestFileInfo + :ivar test_script_file_info: File info. + :vartype test_script_file_info: ~azure.developer.loadtesting.models.TestFileInfo + :ivar user_prop_file_info: File info. + :vartype user_prop_file_info: ~azure.developer.loadtesting.models.TestFileInfo + :ivar input_artifacts_zip_file_info: File info. + :vartype input_artifacts_zip_file_info: ~azure.developer.loadtesting.models.TestFileInfo + :ivar url_test_config_file_info: The config json file for url based test. + :vartype url_test_config_file_info: ~azure.developer.loadtesting.models.TestFileInfo + :ivar additional_file_info: Additional supported files for the test run. + :vartype additional_file_info: list[~azure.developer.loadtesting.models.TestFileInfo] + """ + + config_file_info: Optional["_models.TestFileInfo"] = rest_field(name="configFileInfo") + """File info.""" + test_script_file_info: Optional["_models.TestFileInfo"] = rest_field(name="testScriptFileInfo") + """File info.""" + user_prop_file_info: Optional["_models.TestFileInfo"] = rest_field(name="userPropFileInfo") + """File info.""" + input_artifacts_zip_file_info: Optional["_models.TestFileInfo"] = rest_field(name="inputArtifactsZipFileInfo") + """File info.""" + url_test_config_file_info: Optional["_models.TestFileInfo"] = rest_field(name="urlTestConfigFileInfo") + """The config json file for url based test.""" + additional_file_info: Optional[List["_models.TestFileInfo"]] = rest_field( + name="additionalFileInfo", visibility=["read"] + ) + """Additional supported files for the test run.""" + + @overload + def __init__( + self, + *, + config_file_info: Optional["_models.TestFileInfo"] = None, + test_script_file_info: Optional["_models.TestFileInfo"] = None, + user_prop_file_info: Optional["_models.TestFileInfo"] = None, + input_artifacts_zip_file_info: Optional["_models.TestFileInfo"] = None, + url_test_config_file_info: Optional["_models.TestFileInfo"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRun(_model_base.Model): # pylint: disable=too-many-instance-attributes + """Load test run model. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :vartype test_run_id: str + :ivar pass_fail_criteria: Pass fail criteria for a test. + :vartype pass_fail_criteria: ~azure.developer.loadtesting.models.PassFailCriteria + :ivar auto_stop_criteria: Auto stop criteria for a test. This will automatically stop a load + test if the error percentage is high for a certain time window. + :vartype auto_stop_criteria: ~azure.developer.loadtesting.models.AutoStopCriteria + :ivar secrets: Secrets can be stored in an Azure Key Vault or any other secret store. If the + secret is stored in an Azure Key Vault, the value should be the secret + identifier and the type should be AKV_SECRET_URI. If the secret is stored + elsewhere, the secret value should be provided directly and the type should be + SECRET_VALUE. + :vartype secrets: dict[str, ~azure.developer.loadtesting.models.Secret] + :ivar certificate: Certificates metadata. + :vartype certificate: ~azure.developer.loadtesting.models.CertificateMetadata + :ivar environment_variables: Environment variables which are defined as a set of + pairs. + :vartype environment_variables: dict[str, str] + :ivar error_details: Error details if there is any failure in load test run. + :vartype error_details: list[~azure.developer.loadtesting.models.ErrorDetails] + :ivar test_run_statistics: Test run statistics. + :vartype test_run_statistics: dict[str, ~azure.developer.loadtesting.models.TestRunStatistics] + :ivar load_test_configuration: The load test configuration. + :vartype load_test_configuration: ~azure.developer.loadtesting.models.LoadTestConfiguration + :ivar test_artifacts: Collection of test run artifacts. + :vartype test_artifacts: ~azure.developer.loadtesting.models.TestRunArtifacts + :ivar test_result: Test result for pass/Fail criteria used during the test run. Known values + are: "PASSED", "NOT_APPLICABLE", and "FAILED". + :vartype test_result: str or ~azure.developer.loadtesting.models.PFTestResult + :ivar virtual_users: Number of virtual users, for which test has been run. + :vartype virtual_users: int + :ivar display_name: Display name of a testRun. + :vartype display_name: str + :ivar test_id: Associated test Id. + :vartype test_id: str + :ivar description: The test run description. + :vartype description: str + :ivar status: The test run status. Known values are: "ACCEPTED", "NOTSTARTED", "PROVISIONING", + "PROVISIONED", "CONFIGURING", "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", + "DEPROVISIONED", "DONE", "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + :vartype status: str or ~azure.developer.loadtesting.models.Status + :ivar start_date_time: The test run start DateTime(RFC 3339 literal format). + :vartype start_date_time: ~datetime.datetime + :ivar end_date_time: The test run end DateTime(RFC 3339 literal format). + :vartype end_date_time: ~datetime.datetime + :ivar executed_date_time: Test run initiated time. + :vartype executed_date_time: ~datetime.datetime + :ivar portal_url: Portal url. + :vartype portal_url: str + :ivar duration: Test run duration in milliseconds. + :vartype duration: int + :ivar subnet_id: Subnet ID on which the load test instances should run. + :vartype subnet_id: str + :ivar kind: Type of test. Known values are: "URL" and "JMX". + :vartype kind: str or ~azure.developer.loadtesting.models.TestKind + :ivar public_i_p_disabled: Inject load test engines without deploying public IP for outbound + access. + :vartype public_i_p_disabled: bool + :ivar created_date_time: The creation datetime(RFC 3339 literal format). + :vartype created_date_time: ~datetime.datetime + :ivar created_by: The user that created. + :vartype created_by: str + :ivar last_modified_date_time: The last Modified datetime(RFC 3339 literal format). + :vartype last_modified_date_time: ~datetime.datetime + :ivar last_modified_by: The user that last modified. + :vartype last_modified_by: str + """ + + test_run_id: str = rest_field(name="testRunId", visibility=["read"]) + """Unique test run identifier for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required.""" + pass_fail_criteria: Optional["_models.PassFailCriteria"] = rest_field(name="passFailCriteria") + """Pass fail criteria for a test.""" + auto_stop_criteria: Optional["_models.AutoStopCriteria"] = rest_field(name="autoStopCriteria") + """Auto stop criteria for a test. This will automatically stop a load test if the error percentage + is high for a certain time window.""" + secrets: Optional[Dict[str, "_models.Secret"]] = rest_field() + """Secrets can be stored in an Azure Key Vault or any other secret store. If the + secret is stored in an Azure Key Vault, the value should be the secret + identifier and the type should be AKV_SECRET_URI. If the secret is stored + elsewhere, the secret value should be provided directly and the type should be + SECRET_VALUE.""" + certificate: Optional["_models.CertificateMetadata"] = rest_field() + """Certificates metadata.""" + environment_variables: Optional[Dict[str, str]] = rest_field(name="environmentVariables") + """Environment variables which are defined as a set of pairs.""" + error_details: Optional[List["_models.ErrorDetails"]] = rest_field(name="errorDetails", visibility=["read"]) + """Error details if there is any failure in load test run.""" + test_run_statistics: Optional[Dict[str, "_models.TestRunStatistics"]] = rest_field( + name="testRunStatistics", visibility=["read"] + ) + """Test run statistics.""" + load_test_configuration: Optional["_models.LoadTestConfiguration"] = rest_field(name="loadTestConfiguration") + """The load test configuration.""" + test_artifacts: Optional["_models.TestRunArtifacts"] = rest_field(name="testArtifacts", visibility=["read"]) + """Collection of test run artifacts.""" + test_result: Optional[Union[str, "_models.PFTestResult"]] = rest_field(name="testResult", visibility=["read"]) + """Test result for pass/Fail criteria used during the test run. Known values are: \"PASSED\", + \"NOT_APPLICABLE\", and \"FAILED\".""" + virtual_users: Optional[int] = rest_field(name="virtualUsers", visibility=["read"]) + """Number of virtual users, for which test has been run.""" + display_name: Optional[str] = rest_field(name="displayName") + """Display name of a testRun.""" + test_id: Optional[str] = rest_field(name="testId") + """Associated test Id.""" + description: Optional[str] = rest_field() + """The test run description.""" + status: Optional[Union[str, "_models.Status"]] = rest_field(visibility=["read"]) + """The test run status. Known values are: \"ACCEPTED\", \"NOTSTARTED\", \"PROVISIONING\", + \"PROVISIONED\", \"CONFIGURING\", \"CONFIGURED\", \"EXECUTING\", \"EXECUTED\", + \"DEPROVISIONING\", \"DEPROVISIONED\", \"DONE\", \"CANCELLING\", \"CANCELLED\", \"FAILED\", + \"VALIDATION_SUCCESS\", and \"VALIDATION_FAILURE\".""" + start_date_time: Optional[datetime.datetime] = rest_field( + name="startDateTime", visibility=["read"], format="rfc3339" + ) + """The test run start DateTime(RFC 3339 literal format).""" + end_date_time: Optional[datetime.datetime] = rest_field(name="endDateTime", visibility=["read"], format="rfc3339") + """The test run end DateTime(RFC 3339 literal format).""" + executed_date_time: Optional[datetime.datetime] = rest_field( + name="executedDateTime", visibility=["read"], format="rfc3339" + ) + """Test run initiated time.""" + portal_url: Optional[str] = rest_field(name="portalUrl", visibility=["read"]) + """Portal url.""" + duration: Optional[int] = rest_field(visibility=["read"]) + """Test run duration in milliseconds.""" + subnet_id: Optional[str] = rest_field(name="subnetId", visibility=["read"]) + """Subnet ID on which the load test instances should run.""" + kind: Optional[Union[str, "_models.TestKind"]] = rest_field(visibility=["read"]) + """Type of test. Known values are: \"URL\" and \"JMX\".""" + public_i_p_disabled: Optional[bool] = rest_field(name="publicIPDisabled", visibility=["read"]) + """Inject load test engines without deploying public IP for outbound access.""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The creation datetime(RFC 3339 literal format).""" + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The user that created.""" + last_modified_date_time: Optional[datetime.datetime] = rest_field( + name="lastModifiedDateTime", visibility=["read"], format="rfc3339" + ) + """The last Modified datetime(RFC 3339 literal format).""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The user that last modified.""" + + @overload + def __init__( + self, + *, + pass_fail_criteria: Optional["_models.PassFailCriteria"] = None, + auto_stop_criteria: Optional["_models.AutoStopCriteria"] = None, + secrets: Optional[Dict[str, "_models.Secret"]] = None, + certificate: Optional["_models.CertificateMetadata"] = None, + environment_variables: Optional[Dict[str, str]] = None, + load_test_configuration: Optional["_models.LoadTestConfiguration"] = None, + display_name: Optional[str] = None, + test_id: Optional[str] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunAppComponents(_model_base.Model): + """Test run app component. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar components: Azure resource collection { resource id (fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) + : resource object }. Required. + :vartype components: dict[str, ~azure.developer.loadtesting.models.AppComponent] + :ivar test_run_id: Test run identifier. + :vartype test_run_id: str + :ivar created_date_time: The creation datetime(RFC 3339 literal format). + :vartype created_date_time: ~datetime.datetime + :ivar created_by: The user that created. + :vartype created_by: str + :ivar last_modified_date_time: The last Modified datetime(RFC 3339 literal format). + :vartype last_modified_date_time: ~datetime.datetime + :ivar last_modified_by: The user that last modified. + :vartype last_modified_by: str + """ + + components: Dict[str, "_models.AppComponent"] = rest_field() + """Azure resource collection { resource id (fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) + : resource object }. Required.""" + test_run_id: Optional[str] = rest_field(name="testRunId", visibility=["read"]) + """Test run identifier.""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The creation datetime(RFC 3339 literal format).""" + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The user that created.""" + last_modified_date_time: Optional[datetime.datetime] = rest_field( + name="lastModifiedDateTime", visibility=["read"], format="rfc3339" + ) + """The last Modified datetime(RFC 3339 literal format).""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The user that last modified.""" + + @overload + def __init__( + self, + *, + components: Dict[str, "_models.AppComponent"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunArtifacts(_model_base.Model): + """Collection of test run artifacts. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar input_artifacts: The input artifacts for the test run. + :vartype input_artifacts: ~azure.developer.loadtesting.models.TestRunInputArtifacts + :ivar output_artifacts: The output artifacts for the test run. + :vartype output_artifacts: ~azure.developer.loadtesting.models.TestRunOutputArtifacts + """ + + input_artifacts: Optional["_models.TestRunInputArtifacts"] = rest_field(name="inputArtifacts", visibility=["read"]) + """The input artifacts for the test run.""" + output_artifacts: Optional["_models.TestRunOutputArtifacts"] = rest_field(name="outputArtifacts") + """The output artifacts for the test run.""" + + @overload + def __init__( + self, + *, + output_artifacts: Optional["_models.TestRunOutputArtifacts"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunFileInfo(_model_base.Model): + """Test run file info. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar file_name: Name of the file. Required. + :vartype file_name: str + :ivar url: File URL. + :vartype url: str + :ivar file_type: File type. Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + :vartype file_type: str or ~azure.developer.loadtesting.models.FileType + :ivar expire_date_time: Expiry time of the file (RFC 3339 literal format). + :vartype expire_date_time: ~datetime.datetime + :ivar validation_status: Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + :vartype validation_status: str or ~azure.developer.loadtesting.models.FileStatus + :ivar validation_failure_details: Validation failure error details. + :vartype validation_failure_details: str + """ + + file_name: str = rest_field(name="fileName") + """Name of the file. Required.""" + url: Optional[str] = rest_field(visibility=["read"]) + """File URL.""" + file_type: Optional[Union[str, "_models.FileType"]] = rest_field(name="fileType", visibility=["read"]) + """File type. Known values are: \"JMX_FILE\", \"USER_PROPERTIES\", \"ADDITIONAL_ARTIFACTS\", + \"ZIPPED_ARTIFACTS\", and \"URL_TEST_CONFIG_JSON\".""" + expire_date_time: Optional[datetime.datetime] = rest_field( + name="expireDateTime", visibility=["read"], format="rfc3339" + ) + """Expiry time of the file (RFC 3339 literal format).""" + validation_status: Optional[Union[str, "_models.FileStatus"]] = rest_field( + name="validationStatus", visibility=["read"] + ) + """Validation status of the file. Known values are: \"NOT_VALIDATED\", \"VALIDATION_SUCCESS\", + \"VALIDATION_FAILURE\", \"VALIDATION_INITIATED\", and \"VALIDATION_NOT_REQUIRED\".""" + validation_failure_details: Optional[str] = rest_field(name="validationFailureDetails", visibility=["read"]) + """Validation failure error details.""" + + @overload + def __init__( + self, + *, + file_name: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunInputArtifacts(_model_base.Model): + """The input artifacts for the test run. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar config_file_info: File info. + :vartype config_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar test_script_file_info: File info. + :vartype test_script_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar user_prop_file_info: File info. + :vartype user_prop_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar input_artifacts_zip_file_info: File info. + :vartype input_artifacts_zip_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar url_test_config_file_info: The config json file for url based test. + :vartype url_test_config_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar additional_file_info: Additional supported files for the test run. + :vartype additional_file_info: list[~azure.developer.loadtesting.models.TestRunFileInfo] + """ + + config_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="configFileInfo") + """File info.""" + test_script_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="testScriptFileInfo") + """File info.""" + user_prop_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="userPropFileInfo") + """File info.""" + input_artifacts_zip_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="inputArtifactsZipFileInfo") + """File info.""" + url_test_config_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="urlTestConfigFileInfo") + """The config json file for url based test.""" + additional_file_info: Optional[List["_models.TestRunFileInfo"]] = rest_field( + name="additionalFileInfo", visibility=["read"] + ) + """Additional supported files for the test run.""" + + @overload + def __init__( + self, + *, + config_file_info: Optional["_models.TestRunFileInfo"] = None, + test_script_file_info: Optional["_models.TestRunFileInfo"] = None, + user_prop_file_info: Optional["_models.TestRunFileInfo"] = None, + input_artifacts_zip_file_info: Optional["_models.TestRunFileInfo"] = None, + url_test_config_file_info: Optional["_models.TestRunFileInfo"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunOutputArtifacts(_model_base.Model): + """The output artifacts for the test run. + + :ivar result_file_info: File info. + :vartype result_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar logs_file_info: File info. + :vartype logs_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar artifacts_container_info: The container for test run artifacts. + :vartype artifacts_container_info: ~azure.developer.loadtesting.models.ArtifactsContainerInfo + """ + + result_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="resultFileInfo") + """File info.""" + logs_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="logsFileInfo") + """File info.""" + artifacts_container_info: Optional["_models.ArtifactsContainerInfo"] = rest_field(name="artifactsContainerInfo") + """The container for test run artifacts.""" + + @overload + def __init__( + self, + *, + result_file_info: Optional["_models.TestRunFileInfo"] = None, + logs_file_info: Optional["_models.TestRunFileInfo"] = None, + artifacts_container_info: Optional["_models.ArtifactsContainerInfo"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunServerMetricConfig(_model_base.Model): + """Test run server metrics configuration. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar test_run_id: Test run identifier. + :vartype test_run_id: str + :ivar metrics: Azure resource metrics collection {metric id : metrics object} (Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition + for metric id). + :vartype metrics: dict[str, ~azure.developer.loadtesting.models.ResourceMetric] + :ivar created_date_time: The creation datetime(RFC 3339 literal format). + :vartype created_date_time: ~datetime.datetime + :ivar created_by: The user that created. + :vartype created_by: str + :ivar last_modified_date_time: The last Modified datetime(RFC 3339 literal format). + :vartype last_modified_date_time: ~datetime.datetime + :ivar last_modified_by: The user that last modified. + :vartype last_modified_by: str + """ + + test_run_id: Optional[str] = rest_field(name="testRunId", visibility=["read"]) + """Test run identifier.""" + metrics: Optional[Dict[str, "_models.ResourceMetric"]] = rest_field() + """Azure resource metrics collection {metric id : metrics object} (Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition + for metric id).""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The creation datetime(RFC 3339 literal format).""" + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The user that created.""" + last_modified_date_time: Optional[datetime.datetime] = rest_field( + name="lastModifiedDateTime", visibility=["read"], format="rfc3339" + ) + """The last Modified datetime(RFC 3339 literal format).""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The user that last modified.""" + + @overload + def __init__( + self, + *, + metrics: Optional[Dict[str, "_models.ResourceMetric"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunStatistics(_model_base.Model): # pylint: disable=too-many-instance-attributes + """Test run statistics. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar transaction: Transaction name. + :vartype transaction: str + :ivar sample_count: Sampler count. + :vartype sample_count: float + :ivar error_count: Error count. + :vartype error_count: float + :ivar error_pct: Error percentage. + :vartype error_pct: float + :ivar mean_res_time: Mean response time. + :vartype mean_res_time: float + :ivar median_res_time: Median response time. + :vartype median_res_time: float + :ivar max_res_time: Max response time. + :vartype max_res_time: float + :ivar min_res_time: Minimum response time. + :vartype min_res_time: float + :ivar pct1_res_time: 90 percentile response time. + :vartype pct1_res_time: float + :ivar pct2_res_time: 95 percentile response time. + :vartype pct2_res_time: float + :ivar pct3_res_time: 99 percentile response time. + :vartype pct3_res_time: float + :ivar throughput: Throughput. + :vartype throughput: float + :ivar received_k_bytes_per_sec: Received network bytes. + :vartype received_k_bytes_per_sec: float + :ivar sent_k_bytes_per_sec: Send network bytes. + :vartype sent_k_bytes_per_sec: float + """ + + transaction: Optional[str] = rest_field(visibility=["read"]) + """Transaction name.""" + sample_count: Optional[float] = rest_field(name="sampleCount", visibility=["read"]) + """Sampler count.""" + error_count: Optional[float] = rest_field(name="errorCount", visibility=["read"]) + """Error count.""" + error_pct: Optional[float] = rest_field(name="errorPct", visibility=["read"]) + """Error percentage.""" + mean_res_time: Optional[float] = rest_field(name="meanResTime", visibility=["read"]) + """Mean response time.""" + median_res_time: Optional[float] = rest_field(name="medianResTime", visibility=["read"]) + """Median response time.""" + max_res_time: Optional[float] = rest_field(name="maxResTime", visibility=["read"]) + """Max response time.""" + min_res_time: Optional[float] = rest_field(name="minResTime", visibility=["read"]) + """Minimum response time.""" + pct1_res_time: Optional[float] = rest_field(name="pct1ResTime", visibility=["read"]) + """90 percentile response time.""" + pct2_res_time: Optional[float] = rest_field(name="pct2ResTime", visibility=["read"]) + """95 percentile response time.""" + pct3_res_time: Optional[float] = rest_field(name="pct3ResTime", visibility=["read"]) + """99 percentile response time.""" + throughput: Optional[float] = rest_field(visibility=["read"]) + """Throughput.""" + received_k_bytes_per_sec: Optional[float] = rest_field(name="receivedKBytesPerSec", visibility=["read"]) + """Received network bytes.""" + sent_k_bytes_per_sec: Optional[float] = rest_field(name="sentKBytesPerSec", visibility=["read"]) + """Send network bytes.""" + + +class TestServerMetricConfig(_model_base.Model): + """Test server metrics configuration. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar test_id: Test identifier. + :vartype test_id: str + :ivar metrics: Azure resource metrics collection {metric id : metrics object} (Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition + for metric id). Required. + :vartype metrics: dict[str, ~azure.developer.loadtesting.models.ResourceMetric] + :ivar created_date_time: The creation datetime(RFC 3339 literal format). + :vartype created_date_time: ~datetime.datetime + :ivar created_by: The user that created. + :vartype created_by: str + :ivar last_modified_date_time: The last Modified datetime(RFC 3339 literal format). + :vartype last_modified_date_time: ~datetime.datetime + :ivar last_modified_by: The user that last modified. + :vartype last_modified_by: str + """ + + test_id: Optional[str] = rest_field(name="testId", visibility=["read"]) + """Test identifier.""" + metrics: Dict[str, "_models.ResourceMetric"] = rest_field() + """Azure resource metrics collection {metric id : metrics object} (Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition + for metric id). Required.""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The creation datetime(RFC 3339 literal format).""" + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The user that created.""" + last_modified_date_time: Optional[datetime.datetime] = rest_field( + name="lastModifiedDateTime", visibility=["read"], format="rfc3339" + ) + """The last Modified datetime(RFC 3339 literal format).""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The user that last modified.""" + + @overload + def __init__( + self, + *, + metrics: Dict[str, "_models.ResourceMetric"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TimeSeriesElement(_model_base.Model): + """The time series returned when a data query is performed. + + :ivar data: An array of data points representing the metric values. + :vartype data: list[~azure.developer.loadtesting.models.MetricValue] + :ivar dimension_values: The dimension values. + :vartype dimension_values: list[~azure.developer.loadtesting.models.DimensionValue] + """ + + data: Optional[List["_models.MetricValue"]] = rest_field() + """An array of data points representing the metric values.""" + dimension_values: Optional[List["_models.DimensionValue"]] = rest_field(name="dimensionValues") + """The dimension values.""" + + @overload + def __init__( + self, + *, + data: Optional[List["_models.MetricValue"]] = None, + dimension_values: Optional[List["_models.DimensionValue"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_patch.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/loadtesting/azure-developer-loadtesting/samples/begin_test_run.py b/sdk/loadtesting/azure-developer-loadtesting/samples/begin_test_run.py index f1a34f455b4e..516c22a682b8 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/samples/begin_test_run.py +++ b/sdk/loadtesting/azure-developer-loadtesting/samples/begin_test_run.py @@ -42,10 +42,10 @@ { "testId": TEST_ID, "displayName": "My New Load Test Run", - } + }, ) -#waiting for test run status to be completed with timeout = 3600 seconds +# waiting for test run status to be completed with timeout = 3600 seconds result = testRunPoller.result(3600) print(result["status"]) diff --git a/sdk/loadtesting/azure-developer-loadtesting/samples/create_or_update_test_function.py b/sdk/loadtesting/azure-developer-loadtesting/samples/create_or_update_test_function.py index 968373f5e794..231899a5e9d5 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/samples/create_or_update_test_function.py +++ b/sdk/loadtesting/azure-developer-loadtesting/samples/create_or_update_test_function.py @@ -48,37 +48,25 @@ }, "passFailCriteria": { "passFailMetrics": { - "condition1": { - "clientmetric": "response_time_ms", - "aggregate": "avg", - "condition": ">", - "value": 300 - }, - "condition2": { - "clientmetric": "error", - "aggregate": "percentage", - "condition": ">", - "value": 50 - }, + "condition1": {"clientmetric": "response_time_ms", "aggregate": "avg", "condition": ">", "value": 300}, + "condition2": {"clientmetric": "error", "aggregate": "percentage", "condition": ">", "value": 50}, "condition3": { "clientmetric": "latency", "aggregate": "avg", "condition": ">", "value": 200, - "requestName": "GetCustomerDetails" - } + "requestName": "GetCustomerDetails", + }, } }, "secrets": { "secret1": { "value": "https://sdk-testing-keyvault.vault.azure.net/secrets/sdk-secret", - "type": "AKV_SECRET_URI" + "type": "AKV_SECRET_URI", } }, - "environmentVariables": { - "my-varaible": "value" - } - } + "environmentVariables": {"my-varaible": "value"}, + }, ) print(result) diff --git a/sdk/loadtesting/azure-developer-loadtesting/samples/get_metrics.py b/sdk/loadtesting/azure-developer-loadtesting/samples/get_metrics.py index 0a6fb452426e..69f781d231fb 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/samples/get_metrics.py +++ b/sdk/loadtesting/azure-developer-loadtesting/samples/get_metrics.py @@ -56,7 +56,7 @@ TEST_RUN_ID, metric_name=metric_definitions["value"][0]["name"], metric_namespace=metric_namespaces["value"][0]["name"], - time_interval=test_run_response["startDateTime"]+"/"+test_run_response["endDateTime"] + time_interval=test_run_response["startDateTime"] + "/" + test_run_response["endDateTime"], ) for page in metrics.by_page(): diff --git a/sdk/loadtesting/azure-developer-loadtesting/setup.py b/sdk/loadtesting/azure-developer-loadtesting/setup.py index efe061bdca5c..3867393c7083 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/setup.py +++ b/sdk/loadtesting/azure-developer-loadtesting/setup.py @@ -2,7 +2,7 @@ # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) AutoRest Code Generator. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- # coding: utf-8 @@ -13,7 +13,7 @@ PACKAGE_NAME = "azure-developer-loadtesting" -PACKAGE_PPRINT_NAME = "Azure Developer LoadTesting" +PACKAGE_PPRINT_NAME = "Azure Developer Loadtesting" # a-b-c => a/b/c package_folder_path = PACKAGE_NAME.replace("-", "/") @@ -29,7 +29,7 @@ setup( name=PACKAGE_NAME, version=version, - description="Microsoft Azure Developer LoadTesting Client Library for Python", + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), long_description=open("README.md", "r").read(), long_description_content_type="text/markdown", license="MIT License", @@ -38,15 +38,15 @@ url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", keywords="azure, azure sdk", classifiers=[ - "Development Status :: 5 - Production/Stable", + "Development Status :: 4 - Beta", "Programming Language :: Python", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "License :: OSI Approved :: MIT License", ], zip_safe=False, @@ -60,12 +60,12 @@ ), include_package_data=True, package_data={ - "pytyped": ["py.typed"], + "azure.developer.loadtesting": ["py.typed"], }, install_requires=[ "isodate<1.0.0,>=0.6.1", - "azure-core<2.0.0,>=1.24.0", - "typing-extensions>=4.3.0; python_version<'3.8.0'", + "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", ], - python_requires=">=3.7", + python_requires=">=3.8", ) diff --git a/sdk/loadtesting/azure-developer-loadtesting/tests/conftest.py b/sdk/loadtesting/azure-developer-loadtesting/tests/conftest.py index b8c81835777c..65b0a4c7af53 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/tests/conftest.py +++ b/sdk/loadtesting/azure-developer-loadtesting/tests/conftest.py @@ -30,10 +30,16 @@ from dotenv import load_dotenv -from devtools_testutils import test_proxy, add_general_regex_sanitizer, add_body_key_sanitizer, add_header_regex_sanitizer +from devtools_testutils import ( + test_proxy, + add_general_regex_sanitizer, + add_body_key_sanitizer, + add_header_regex_sanitizer, +) load_dotenv() + @pytest.fixture(scope="session", autouse=True) def add_sanitizers(test_proxy): subscription_id = os.environ.get("LOADTESTING_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000") diff --git a/sdk/loadtesting/azure-developer-loadtesting/tests/test_admin_ops.py b/sdk/loadtesting/azure-developer-loadtesting/tests/test_admin_ops.py index b79e97d3be18..0020073881e2 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/tests/test_admin_ops.py +++ b/sdk/loadtesting/azure-developer-loadtesting/tests/test_admin_ops.py @@ -15,8 +15,9 @@ DISPLAY_NAME = "TestingResourcePyTest" NON_EXISTING_RESOURCE = "nonexistingresource" -class TestLoadTestAdministrationClient(LoadtestingTest): + +class TestLoadTestAdministrationClient(LoadtestingTest): def setup_create_load_test(self, endpoint): self.setup_load_test_id = "pytest_setup_load_test_id" client = self.create_administration_client(endpoint) @@ -36,13 +37,17 @@ def setup_create_load_test(self, endpoint): "passFailCriteria": {"passFailMetrics": {}}, "keyvaultReferenceIdentityType": "SystemAssigned", "keyvaultReferenceIdentityId": None, - } + }, ) def setup_upload_test_file(self, endpoint): client = self.create_administration_client(endpoint) self.setup_file_name = "sample.jmx" - client.begin_upload_test_file(self.setup_load_test_id, "sample.jmx", open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb")) + client.begin_upload_test_file( + self.setup_load_test_id, + "sample.jmx", + open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb"), + ) def setup_app_components(self, endpoint, resource_id): client = self.create_administration_client(endpoint) @@ -60,6 +65,7 @@ def setup_app_components(self, endpoint, resource_id): }, }, ) + @LoadtestingPowerShellPreparer() @recorded_by_proxy def test_create_or_update_load_test(self, loadtesting_endpoint, loadtesting_test_id): @@ -140,7 +146,6 @@ def test_list_load_tests(self, loadtesting_endpoint): result = client.list_tests() assert result is not None - @LoadtestingPowerShellPreparer() @recorded_by_proxy def test_get_test_file(self, loadtesting_endpoint): @@ -169,7 +174,6 @@ def test_delete_test_file(self, loadtesting_endpoint): with pytest.raises(ResourceNotFoundError): client.delete_test_file(self.setup_load_test_id, "nonexistent.jmx") - @LoadtestingPowerShellPreparer() @recorded_by_proxy def list_test_files(self, loadtesting_endpoint): @@ -193,17 +197,15 @@ def test_create_or_update_app_components(self, loadtesting_endpoint, loadtesting result = client.create_or_update_app_components( loadtesting_test_id, { - "components": - { - loadtesting_resource_id: - { + "components": { + loadtesting_resource_id: { "resourceId": loadtesting_resource_id, "resourceName": "App-Service-Sample-Demo", "resourceType": "Microsoft.Web/sites", - "kind": "web" + "kind": "web", } } - } + }, ) assert result is not None @@ -219,7 +221,7 @@ def test_create_or_update_app_components(self, loadtesting_endpoint, loadtesting "kind": "web", } } - } + }, ) @LoadtestingPowerShellPreparer() @@ -243,8 +245,11 @@ def test_file_upload_poller(self, loadtesting_endpoint): self.setup_create_load_test(loadtesting_endpoint) client = self.create_administration_client(loadtesting_endpoint) - poller = client.begin_upload_test_file(self.setup_load_test_id, "sample.jmx", - open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb")) + poller = client.begin_upload_test_file( + self.setup_load_test_id, + "sample.jmx", + open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb"), + ) result = poller.result(1000) assert poller.status() is not None @@ -253,7 +258,9 @@ def test_file_upload_poller(self, loadtesting_endpoint): @LoadtestingPowerShellPreparer() @recorded_by_proxy - def test_create_or_update_server_metrics_config(self, loadtesting_endpoint, loadtesting_resource_id, loadtesting_test_id): + def test_create_or_update_server_metrics_config( + self, loadtesting_endpoint, loadtesting_resource_id, loadtesting_test_id + ): set_bodiless_matcher() client = self.create_administration_client(loadtesting_endpoint) @@ -268,10 +275,10 @@ def test_create_or_update_server_metrics_config(self, loadtesting_endpoint, load "name": "requests/duration", "aggregation": "Average", "unit": None, - "resourceType": "microsoft.insights/components" + "resourceType": "microsoft.insights/components", } } - } + }, ) assert result is not None diff --git a/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_admin_ops.py b/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_admin_ops.py index 53f564567b6d..569955c0dab2 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_admin_ops.py +++ b/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_admin_ops.py @@ -17,8 +17,9 @@ DISPLAY_NAME = "TestingResourcePyTest" NON_EXISTING_RESOURCE = "nonexistingresource" -class TestLoadTestAdministrationClient(LoadtestingAsyncTest): + +class TestLoadTestAdministrationClient(LoadtestingAsyncTest): async def setup_create_load_test(self, endpoint): self.setup_load_test_id = "pytest_setup_load_test_id" client = self.create_administration_client(endpoint) @@ -38,13 +39,17 @@ async def setup_create_load_test(self, endpoint): "passFailCriteria": {"passFailMetrics": {}}, "keyvaultReferenceIdentityType": "SystemAssigned", "keyvaultReferenceIdentityId": None, - } + }, ) async def setup_upload_test_file(self, endpoint): client = self.create_administration_client(endpoint) self.setup_file_name = "sample.jmx" - await client.begin_upload_test_file(self.setup_load_test_id, "sample.jmx", open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb")) + await client.begin_upload_test_file( + self.setup_load_test_id, + "sample.jmx", + open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb"), + ) async def setup_app_components(self, endpoint, resource_id): client = self.create_administration_client(endpoint) @@ -62,6 +67,7 @@ async def setup_app_components(self, endpoint, resource_id): }, }, ) + @LoadtestingPowerShellPreparer() @recorded_by_proxy_async async def test_create_or_update_load_test(self, loadtesting_endpoint, loadtesting_test_id): @@ -142,7 +148,6 @@ async def test_list_load_tests(self, loadtesting_endpoint): result = client.list_tests() assert result is not None - @LoadtestingPowerShellPreparer() @recorded_by_proxy_async async def test_get_test_file(self, loadtesting_endpoint): @@ -171,7 +176,6 @@ async def test_delete_test_file(self, loadtesting_endpoint): with pytest.raises(ResourceNotFoundError): await client.delete_test_file(self.setup_load_test_id, "nonexistent.jmx") - @LoadtestingPowerShellPreparer() @recorded_by_proxy_async async def list_test_files(self, loadtesting_endpoint): @@ -188,24 +192,24 @@ async def list_test_files(self, loadtesting_endpoint): @LoadtestingPowerShellPreparer() @recorded_by_proxy_async - async def test_create_or_update_app_components(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_resource_id): + async def test_create_or_update_app_components( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_resource_id + ): set_bodiless_matcher() client = self.create_administration_client(loadtesting_endpoint) result = await client.create_or_update_app_components( loadtesting_test_id, { - "components": - { - loadtesting_resource_id: - { + "components": { + loadtesting_resource_id: { "resourceId": loadtesting_resource_id, "resourceName": "App-Service-Sample-Demo", "resourceType": "Microsoft.Web/sites", - "kind": "web" + "kind": "web", } } - } + }, ) assert result is not None @@ -221,7 +225,7 @@ async def test_create_or_update_app_components(self, loadtesting_endpoint, loadt "kind": "web", } } - } + }, ) @LoadtestingPowerShellPreparer() @@ -245,8 +249,11 @@ async def test_file_upload_poller(self, loadtesting_endpoint): await self.setup_create_load_test(loadtesting_endpoint) client = self.create_administration_client(loadtesting_endpoint) - poller = await client.begin_upload_test_file(self.setup_load_test_id, "sample.jmx", - open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb")) + poller = await client.begin_upload_test_file( + self.setup_load_test_id, + "sample.jmx", + open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb"), + ) result = await poller.result() assert poller.status() is not None @@ -255,7 +262,9 @@ async def test_file_upload_poller(self, loadtesting_endpoint): @LoadtestingPowerShellPreparer() @recorded_by_proxy_async - async def test_create_or_update_server_metrics_config(self, loadtesting_endpoint, loadtesting_resource_id, loadtesting_test_id): + async def test_create_or_update_server_metrics_config( + self, loadtesting_endpoint, loadtesting_resource_id, loadtesting_test_id + ): set_bodiless_matcher() client = self.create_administration_client(loadtesting_endpoint) @@ -270,10 +279,10 @@ async def test_create_or_update_server_metrics_config(self, loadtesting_endpoint "name": "requests/duration", "aggregation": "Average", "unit": None, - "resourceType": "microsoft.insights/components" + "resourceType": "microsoft.insights/components", } } - } + }, ) assert result is not None diff --git a/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_run_ops.py b/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_run_ops.py index 6265141f4b6e..4bee7fc804c6 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_run_ops.py +++ b/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_run_ops.py @@ -17,8 +17,9 @@ DISPLAY_NAME = "TestingResourcePyTest" NON_EXISTING_RESOURCE = "nonexistingresource" -class TestRunOps(LoadtestingAsyncTest): + +class TestRunOps(LoadtestingAsyncTest): async def setup_loadtest(self, endpoint, test_id): admin_client = self.create_administration_client(endpoint) @@ -37,7 +38,7 @@ async def setup_loadtest(self, endpoint, test_id): "passFailCriteria": {"passFailMetrics": {}}, "keyvaultReferenceIdentityType": "SystemAssigned", "keyvaultReferenceIdentityId": None, - } + }, ) validation_poller = await admin_client.begin_upload_test_file( @@ -56,7 +57,7 @@ async def setup_test_run(self, endpoint, test_id, test_run_id): { "testId": test_id, "displayName": "My New Load Test Run from PyTest", - } + }, ) await run_poller.result() @@ -74,7 +75,7 @@ async def test_test_run_poller(self, loadtesting_endpoint, loadtesting_test_id, { "testId": loadtesting_test_id, "displayName": "My New Load Test Run from PyTest", - } + }, ) result = await run_poller.result() @@ -111,7 +112,6 @@ async def test_delete_test_run(self, loadtesting_endpoint, loadtesting_test_id, with pytest.raises(ResourceNotFoundError): await run_client.delete_test_run(NON_EXISTING_RESOURCE) - @LoadtestingPowerShellPreparer() @recorded_by_proxy_async async def test_get_test_run_file(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id): @@ -130,7 +130,6 @@ async def test_get_test_run_file(self, loadtesting_endpoint, loadtesting_test_id with pytest.raises(HttpResponseError): await run_client.get_test_run_file(loadtesting_test_run_id, NON_EXISTING_RESOURCE) - @LoadtestingPowerShellPreparer() @recorded_by_proxy_async async def test_list_test_runs(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id): @@ -143,7 +142,6 @@ async def test_list_test_runs(self, loadtesting_endpoint, loadtesting_test_id, l result = run_client.list_test_runs() assert result is not None - @LoadtestingPowerShellPreparer() @recorded_by_proxy_async async def test_stop_test_run(self, loadtesting_endpoint): @@ -162,7 +160,7 @@ async def test_stop_test_run(self, loadtesting_endpoint): { "testId": "new-load-test-from-pytest-aio-abc", "displayName": "My New Load Test Run from PyTest", - } + }, ) result = await run_client.stop_test_run("my-new-test-run-from-pytest-aio-abc") @@ -182,21 +180,24 @@ async def test_get_metrics(self, loadtesting_endpoint, loadtesting_test_id, load metric_namespaces = await run_client.get_metric_namespaces(loadtesting_test_run_id) assert metric_namespaces is not None - metric_definitions = await run_client.get_metric_definitions(loadtesting_test_run_id, - metric_namespace=metric_namespaces["value"][0]["name"]) + metric_definitions = await run_client.get_metric_definitions( + loadtesting_test_run_id, metric_namespace=metric_namespaces["value"][0]["name"] + ) assert metric_definitions is not None metrics = run_client.list_metrics( test_run_id=loadtesting_test_run_id, metric_name=metric_definitions["value"][0]["name"], metric_namespace=metric_namespaces["value"][0]["name"], - time_interval=test_run_response["startDateTime"] + "/" + test_run_response["endDateTime"] + time_interval=test_run_response["startDateTime"] + "/" + test_run_response["endDateTime"], ) assert metrics is not None @LoadtestingPowerShellPreparer() @recorded_by_proxy_async - async def test_create_or_update_app_component(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + async def test_create_or_update_app_component( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() await self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) @@ -206,17 +207,15 @@ async def test_create_or_update_app_component(self, loadtesting_endpoint, loadte result = await run_client.create_or_update_app_components( loadtesting_test_run_id, { - "components": - { - loadtesting_resource_id: - { - "resourceId": loadtesting_resource_id, - "resourceName": "App-Service-Sample-Demo", - "resourceType": "Microsoft.Web/sites", - "kind": "web" - } + "components": { + loadtesting_resource_id: { + "resourceId": loadtesting_resource_id, + "resourceName": "App-Service-Sample-Demo", + "resourceType": "Microsoft.Web/sites", + "kind": "web", } - } + } + }, ) assert result is not None @@ -224,22 +223,22 @@ async def test_create_or_update_app_component(self, loadtesting_endpoint, loadte await run_client.create_or_update_app_components( NON_EXISTING_RESOURCE, { - "components": - { - loadtesting_resource_id: - { - "resourceId": loadtesting_resource_id, - "resourceName": "App-Service-Sample-Demo", - "resourceType": "Microsoft.Web/sites", - "kind": "web" - } + "components": { + loadtesting_resource_id: { + "resourceId": loadtesting_resource_id, + "resourceName": "App-Service-Sample-Demo", + "resourceType": "Microsoft.Web/sites", + "kind": "web", } - } + } + }, ) @LoadtestingPowerShellPreparer() @recorded_by_proxy_async - async def test_get_app_component(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + async def test_get_app_component( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() await self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) @@ -250,7 +249,9 @@ async def test_get_app_component(self, loadtesting_endpoint, loadtesting_test_id @LoadtestingPowerShellPreparer() @recorded_by_proxy_async - async def test_create_or_update_server_metrics_config(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + async def test_create_or_update_server_metrics_config( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() await self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) @@ -267,20 +268,22 @@ async def test_create_or_update_server_metrics_config(self, loadtesting_endpoint "name": "requests/duration", "aggregation": "Average", "unit": None, - "resourceType": "microsoft.insights/components" + "resourceType": "microsoft.insights/components", } } - } + }, ) assert result is not None @LoadtestingPowerShellPreparer() @recorded_by_proxy_async - async def test_get_server_metrics_config(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + async def test_get_server_metrics_config( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() await self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) run_client = self.create_run_client(loadtesting_endpoint) result = await run_client.get_server_metrics_config(loadtesting_test_run_id) - assert result is not None \ No newline at end of file + assert result is not None diff --git a/sdk/loadtesting/azure-developer-loadtesting/tests/test_run_ops.py b/sdk/loadtesting/azure-developer-loadtesting/tests/test_run_ops.py index 23781caa0436..7a87dc0e59fe 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/tests/test_run_ops.py +++ b/sdk/loadtesting/azure-developer-loadtesting/tests/test_run_ops.py @@ -16,8 +16,8 @@ DISPLAY_NAME = "TestingResourcePyTest" NON_EXISTING_RESOURCE = "nonexistingresource" -class TestRunOps(LoadtestingTest): +class TestRunOps(LoadtestingTest): def setup_loadtest(self, endpoint, test_id): admin_client = self.create_administration_client(endpoint) @@ -36,7 +36,7 @@ def setup_loadtest(self, endpoint, test_id): "passFailCriteria": {"passFailMetrics": {}}, "keyvaultReferenceIdentityType": "SystemAssigned", "keyvaultReferenceIdentityId": None, - } + }, ) validation_poller = admin_client.begin_upload_test_file( @@ -55,7 +55,7 @@ def setup_test_run(self, endpoint, test_id, test_run_id): { "testId": test_id, "displayName": "My New Load Test Run from PyTest", - } + }, ) run_poller.result(10800) @@ -110,7 +110,6 @@ def test_delete_test_run(self, loadtesting_endpoint, loadtesting_test_id, loadte with pytest.raises(ResourceNotFoundError): run_client.delete_test_run(NON_EXISTING_RESOURCE) - @LoadtestingPowerShellPreparer() @recorded_by_proxy def test_get_test_run_file(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id): @@ -129,7 +128,6 @@ def test_get_test_run_file(self, loadtesting_endpoint, loadtesting_test_id, load with pytest.raises(HttpResponseError): run_client.get_test_run_file(loadtesting_test_run_id, NON_EXISTING_RESOURCE) - @LoadtestingPowerShellPreparer() @recorded_by_proxy def test_list_test_runs(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id): @@ -142,7 +140,6 @@ def test_list_test_runs(self, loadtesting_endpoint, loadtesting_test_id, loadtes result = run_client.list_test_runs() assert result is not None - @LoadtestingPowerShellPreparer() @recorded_by_proxy def test_stop_test_run(self, loadtesting_endpoint): @@ -161,7 +158,7 @@ def test_stop_test_run(self, loadtesting_endpoint): { "testId": "new-load-test-from-pytest-abc", "displayName": "My New Load Test Run from PyTest", - } + }, ) result = run_client.stop_test_run("my-new-test-run-from-pytest") @@ -170,7 +167,6 @@ def test_stop_test_run(self, loadtesting_endpoint): with pytest.raises(ResourceNotFoundError): run_client.stop_test_run(NON_EXISTING_RESOURCE) - @LoadtestingPowerShellPreparer() @recorded_by_proxy def test_get_metrics(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id): @@ -185,21 +181,24 @@ def test_get_metrics(self, loadtesting_endpoint, loadtesting_test_id, loadtestin metric_namespaces = run_client.get_metric_namespaces(loadtesting_test_run_id) assert metric_namespaces is not None - metric_definitions = run_client.get_metric_definitions(loadtesting_test_run_id, - metric_namespace=metric_namespaces["value"][0]["name"]) + metric_definitions = run_client.get_metric_definitions( + loadtesting_test_run_id, metric_namespace=metric_namespaces["value"][0]["name"] + ) assert metric_definitions is not None metrics = run_client.list_metrics( test_run_id=loadtesting_test_run_id, metric_name=metric_definitions["value"][0]["name"], metric_namespace=metric_namespaces["value"][0]["name"], - time_interval=test_run_response["startDateTime"] + "/" + test_run_response["endDateTime"] + time_interval=test_run_response["startDateTime"] + "/" + test_run_response["endDateTime"], ) assert metrics is not None @LoadtestingPowerShellPreparer() @recorded_by_proxy - def test_create_or_update_app_component(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + def test_create_or_update_app_component( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) @@ -209,17 +208,15 @@ def test_create_or_update_app_component(self, loadtesting_endpoint, loadtesting_ result = run_client.create_or_update_app_components( loadtesting_test_run_id, { - "components": - { - loadtesting_resource_id: - { - "resourceId": loadtesting_resource_id, - "resourceName": "App-Service-Sample-Demo", - "resourceType": "Microsoft.Web/sites", - "kind": "web" - } + "components": { + loadtesting_resource_id: { + "resourceId": loadtesting_resource_id, + "resourceName": "App-Service-Sample-Demo", + "resourceType": "Microsoft.Web/sites", + "kind": "web", } - } + } + }, ) assert result is not None @@ -227,22 +224,22 @@ def test_create_or_update_app_component(self, loadtesting_endpoint, loadtesting_ run_client.create_or_update_app_components( NON_EXISTING_RESOURCE, { - "components": - { - loadtesting_resource_id: - { - "resourceId": loadtesting_resource_id, - "resourceName": "App-Service-Sample-Demo", - "resourceType": "Microsoft.Web/sites", - "kind": "web" - } + "components": { + loadtesting_resource_id: { + "resourceId": loadtesting_resource_id, + "resourceName": "App-Service-Sample-Demo", + "resourceType": "Microsoft.Web/sites", + "kind": "web", } - } + } + }, ) @LoadtestingPowerShellPreparer() @recorded_by_proxy - def test_get_app_component(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + def test_get_app_component( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) @@ -253,7 +250,9 @@ def test_get_app_component(self, loadtesting_endpoint, loadtesting_test_id, load @LoadtestingPowerShellPreparer() @recorded_by_proxy - def test_create_or_update_server_metrics_config(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + def test_create_or_update_server_metrics_config( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) @@ -270,20 +269,22 @@ def test_create_or_update_server_metrics_config(self, loadtesting_endpoint, load "name": "requests/duration", "aggregation": "Average", "unit": None, - "resourceType": "microsoft.insights/components" + "resourceType": "microsoft.insights/components", } } - } + }, ) assert result is not None @LoadtestingPowerShellPreparer() @recorded_by_proxy - def test_get_server_metrics_config(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + def test_get_server_metrics_config( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) run_client = self.create_run_client(loadtesting_endpoint) result = run_client.get_server_metrics_config(loadtesting_test_run_id) - assert result is not None \ No newline at end of file + assert result is not None diff --git a/sdk/loadtesting/azure-developer-loadtesting/tests/testcase.py b/sdk/loadtesting/azure-developer-loadtesting/tests/testcase.py index 4c662118b11c..cad9fb27d10b 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/tests/testcase.py +++ b/sdk/loadtesting/azure-developer-loadtesting/tests/testcase.py @@ -9,8 +9,8 @@ from devtools_testutils import AzureRecordedTestCase, PowerShellPreparer from azure.developer.loadtesting import LoadTestAdministrationClient, LoadTestRunClient -class LoadtestingTest(AzureRecordedTestCase): +class LoadtestingTest(AzureRecordedTestCase): def create_administration_client(self, endpoint): credential = self.get_credential(LoadTestAdministrationClient) return self.create_client_from_credential( diff --git a/sdk/loadtesting/azure-developer-loadtesting/tsp-location.yaml b/sdk/loadtesting/azure-developer-loadtesting/tsp-location.yaml new file mode 100644 index 000000000000..fa9cd66a2003 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/tsp-location.yaml @@ -0,0 +1,5 @@ +directory: specification/loadtestservice/LoadTestService +additionalDirectories: [] +repo: Azure/azure-rest-api-specs +commit: 70a4ccdd2be61ae5bc524250c70270b0f4f2b540 + diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/CHANGELOG.md b/sdk/programmableconnectivity/azure-programmableconnectivity/CHANGELOG.md new file mode 100644 index 000000000000..628743d283a9 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/CHANGELOG.md @@ -0,0 +1,5 @@ +# Release History + +## 1.0.0b1 (1970-01-01) + +- Initial version diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/LICENSE b/sdk/programmableconnectivity/azure-programmableconnectivity/LICENSE new file mode 100644 index 000000000000..63447fd8bbbf --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/MANIFEST.in b/sdk/programmableconnectivity/azure-programmableconnectivity/MANIFEST.in new file mode 100644 index 000000000000..3882ed1ad810 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/MANIFEST.in @@ -0,0 +1,6 @@ +include *.md +include LICENSE +include azure/programmableconnectivity/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py \ No newline at end of file diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/README.md b/sdk/programmableconnectivity/azure-programmableconnectivity/README.md new file mode 100644 index 000000000000..84d276792541 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/README.md @@ -0,0 +1,80 @@ + + +# Azure Programmableconnectivity client library for Python + + +## Getting started + +### Installating the package + +```bash +python -m pip install azure-programmableconnectivity +``` + +#### Prequisites + +- Python 3.8 or later is required to use this package. +- You need an [Azure subscription][azure_sub] to use this package. +- An existing Azure Programmableconnectivity instance. +#### Create with an Azure Active Directory Credential +To use an [Azure Active Directory (AAD) token credential][authenticate_with_token], +provide an instance of the desired credential type obtained from the +[azure-identity][azure_identity_credentials] library. + +To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip] + +After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use. +As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client: + +Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: +`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET` + +Use the returned token credential to authenticate the client: + +```python +>>> from azure.programmableconnectivity import ProgrammableConnectivityClient +>>> from azure.identity import DefaultAzureCredential +>>> client = ProgrammableConnectivityClient(endpoint='', credential=DefaultAzureCredential()) +``` + +## Examples + +```python +>>> from azure.programmableconnectivity import ProgrammableConnectivityClient +>>> from azure.identity import DefaultAzureCredential +>>> from azure.core.exceptions import HttpResponseError + +>>> client = ProgrammableConnectivityClient(endpoint='', credential=DefaultAzureCredential()) +>>> try: + + except HttpResponseError as e: + print('service responds error: {}'.format(e.response.json())) + +``` + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials +[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential +[pip]: https://pypi.org/project/pip/ +[azure_sub]: https://azure.microsoft.com/free/ + diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/_meta.json b/sdk/programmableconnectivity/azure-programmableconnectivity/_meta.json new file mode 100644 index 000000000000..4904dcaf757c --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "70a4ccdd2be61ae5bc524250c70270b0f4f2b540", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/programmableconnectivity/Azure.ProgrammableConnectivity", + "@azure-tools/typespec-python": "0.21.0" +} \ No newline at end of file diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/__init__.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/__init__.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/__init__.py new file mode 100644 index 000000000000..7050026a813f --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/__init__.py @@ -0,0 +1,26 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import ProgrammableConnectivityClient +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "ProgrammableConnectivityClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_client.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_client.py new file mode 100644 index 000000000000..b29b47d83754 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_client.py @@ -0,0 +1,121 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, TYPE_CHECKING + +from azure.core import PipelineClient +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import ProgrammableConnectivityClientConfiguration +from ._serialization import Deserializer, Serializer +from .operations import ( + DeviceLocationOperations, + DeviceNetworkOperations, + NumberVerificationOperations, + SimSwapOperations, +) + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class ProgrammableConnectivityClient: # pylint: disable=client-accepts-api-version-keyword + """Azure Programmable Connectivity (APC) provides a unified interface to the Network APIs of + multiple Telecom Operators. Note that Operators may deprecate a Network API with less advance + notice than the Azure standard, in which case APC will also deprecate that Network API. + + :ivar device_location: DeviceLocationOperations operations + :vartype device_location: azure.programmableconnectivity.operations.DeviceLocationOperations + :ivar device_network: DeviceNetworkOperations operations + :vartype device_network: azure.programmableconnectivity.operations.DeviceNetworkOperations + :ivar number_verification: NumberVerificationOperations operations + :vartype number_verification: + azure.programmableconnectivity.operations.NumberVerificationOperations + :ivar sim_swap: SimSwapOperations operations + :vartype sim_swap: azure.programmableconnectivity.operations.SimSwapOperations + :param endpoint: An Azure Programmable Connectivity Endpoint providing access to Network APIs, + for example https://{region}.apcgatewayapi.azure.com. Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2024-02-09-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + _endpoint = "{endpoint}" + self._config = ProgrammableConnectivityClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + self.device_location = DeviceLocationOperations(self._client, self._config, self._serialize, self._deserialize) + self.device_network = DeviceNetworkOperations(self._client, self._config, self._serialize, self._deserialize) + self.number_verification = NumberVerificationOperations( + self._client, self._config, self._serialize, self._deserialize + ) + self.sim_swap = SimSwapOperations(self._client, self._config, self._serialize, self._deserialize) + + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> "ProgrammableConnectivityClient": + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_configuration.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_configuration.py new file mode 100644 index 000000000000..08d78c2365ef --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_configuration.py @@ -0,0 +1,66 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies + +from ._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class ProgrammableConnectivityClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for ProgrammableConnectivityClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: An Azure Programmable Connectivity Endpoint providing access to Network APIs, + for example https://{region}.apcgatewayapi.azure.com. Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2024-02-09-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2024-02-09-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com//.default"]) + kwargs.setdefault("sdk_moniker", "programmableconnectivity/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.BearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_model_base.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_model_base.py new file mode 100644 index 000000000000..1ddc071517d6 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_model_base.py @@ -0,0 +1,874 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except + +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import copy +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] # pylint: disable=protected-access + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): # pylint: disable=unsubscriptable-object + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = copy.deepcopy(data) + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: + ... + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: + ... + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + return self._data.popitem() + + def clear(self) -> None: + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: + ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: + ... + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument + # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' + mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") # pylint: disable=no-member + for k, v in mro_class.__annotations__.items() # pylint: disable=no-member + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) + + return super().__new__(cls) # pylint: disable=no-value-for-parameter + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): # pylint: disable=no-member + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: + for v in cls.__dict__.values(): + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access + return v._rest_name # pylint: disable=protected-access + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): # pylint: disable=no-member + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member + if mapped_cls == cls: + return cls(data) + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation or annotation in [int, float]: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + except AttributeError: + pass + + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) + + try: + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + obj: typing.Dict[typing.Any, typing.Any], + ): + if obj is None: + return obj + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + return functools.partial( + _deserialize_dict, + value_deserializer, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore + + def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, + ): + if obj is None: + return obj + return type(obj)( + _deserialize(deserializer, entry, module) + for entry, deserializer in zip(obj, entry_deserializers) + ) + + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + obj, + ): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + return functools.partial(_deserialize_sequence, deserializer) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): + try: + if value is None or isinstance(value, _Null): + return None + if deserializer is None: + return value + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_patch.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_serialization.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_serialization.py new file mode 100644 index 000000000000..2f781d740827 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_serialization.py @@ -0,0 +1,1998 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the ""Software""), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + TypeVar, + MutableMapping, + Type, + List, + Mapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +ModelType = TypeVar("ModelType", bound="Model") +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + + +try: + from datetime import timezone as _FixedOffset # type: ignore +except ImportError: # Python 2.7 + + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds() / 3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node.""" + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls: Type[ModelType], + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> ModelType: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result.update(objects[valuetype]._flatten_subtype(key, objects)) + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + Remove the polymorphic key from the initial data. + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + """ + return key.replace("\\.", ".") + + +class Serializer(object): + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises: SerializationError if serialization fails. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized.update(target_obj.additional_properties) + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises: SerializationError if serialization fails. + :raises: ValueError if data is None + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + elif data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, data.__class__) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param data: Object to be serialized. + :rtype: str + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + else: + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. + :rtype: list, str + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + elif obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises: SerializationError if format invalid + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError: + raise TypeError("Unix time object must be valid Datetime object.") + + +def rest_key_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(List[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key.""" + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + else: + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + else: # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer(object): + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + elif isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None: + return data + try: + attributes = response._attribute_map # type: ignore + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + else: + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param raw_data: Data to be processed. + :param content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param response: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [k for k, v in response._validation.items() if v.get("readonly")] + const = [k for k, v in response._validation.items() if v.get("constant")] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) + + def deserialize_data(self, data, data_type): + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + else: + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :rtype: dict + :raises: TypeError if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :rtype: str, int, float or bool + :raises: TypeError if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + else: + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + elif isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + elif attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + else: + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :rtype: long or int + :raises: ValueError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :rtype: TimeDelta + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :rtype: Date + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :rtype: Datetime + :raises: DeserializationError if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + else: + return date_obj diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_version.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_version.py new file mode 100644 index 000000000000..be71c81bd282 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/__init__.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/__init__.py new file mode 100644 index 000000000000..ae6647e003e5 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/__init__.py @@ -0,0 +1,23 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import ProgrammableConnectivityClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "ProgrammableConnectivityClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/_client.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/_client.py new file mode 100644 index 000000000000..5a4bf70769de --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/_client.py @@ -0,0 +1,124 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable, TYPE_CHECKING + +from azure.core import AsyncPipelineClient +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._serialization import Deserializer, Serializer +from ._configuration import ProgrammableConnectivityClientConfiguration +from .operations import ( + DeviceLocationOperations, + DeviceNetworkOperations, + NumberVerificationOperations, + SimSwapOperations, +) + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class ProgrammableConnectivityClient: # pylint: disable=client-accepts-api-version-keyword + """Azure Programmable Connectivity (APC) provides a unified interface to the Network APIs of + multiple Telecom Operators. Note that Operators may deprecate a Network API with less advance + notice than the Azure standard, in which case APC will also deprecate that Network API. + + :ivar device_location: DeviceLocationOperations operations + :vartype device_location: + azure.programmableconnectivity.aio.operations.DeviceLocationOperations + :ivar device_network: DeviceNetworkOperations operations + :vartype device_network: azure.programmableconnectivity.aio.operations.DeviceNetworkOperations + :ivar number_verification: NumberVerificationOperations operations + :vartype number_verification: + azure.programmableconnectivity.aio.operations.NumberVerificationOperations + :ivar sim_swap: SimSwapOperations operations + :vartype sim_swap: azure.programmableconnectivity.aio.operations.SimSwapOperations + :param endpoint: An Azure Programmable Connectivity Endpoint providing access to Network APIs, + for example https://{region}.apcgatewayapi.azure.com. Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2024-02-09-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + _endpoint = "{endpoint}" + self._config = ProgrammableConnectivityClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + self.device_location = DeviceLocationOperations(self._client, self._config, self._serialize, self._deserialize) + self.device_network = DeviceNetworkOperations(self._client, self._config, self._serialize, self._deserialize) + self.number_verification = NumberVerificationOperations( + self._client, self._config, self._serialize, self._deserialize + ) + self.sim_swap = SimSwapOperations(self._client, self._config, self._serialize, self._deserialize) + + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> "ProgrammableConnectivityClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/_configuration.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/_configuration.py new file mode 100644 index 000000000000..e2d07e44cab0 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/_configuration.py @@ -0,0 +1,66 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies + +from .._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class ProgrammableConnectivityClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for ProgrammableConnectivityClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: An Azure Programmable Connectivity Endpoint providing access to Network APIs, + for example https://{region}.apcgatewayapi.azure.com. Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2024-02-09-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2024-02-09-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com//.default"]) + kwargs.setdefault("sdk_moniker", "programmableconnectivity/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AsyncBearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/_patch.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/operations/__init__.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/operations/__init__.py new file mode 100644 index 000000000000..438712907b24 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/operations/__init__.py @@ -0,0 +1,25 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import DeviceLocationOperations +from ._operations import DeviceNetworkOperations +from ._operations import NumberVerificationOperations +from ._operations import SimSwapOperations + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DeviceLocationOperations", + "DeviceNetworkOperations", + "NumberVerificationOperations", + "SimSwapOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/operations/_operations.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/operations/_operations.py new file mode 100644 index 000000000000..052b32611e03 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/operations/_operations.py @@ -0,0 +1,1412 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._model_base import SdkJSONEncoder, _deserialize +from ...operations._operations import ( + build_device_location_verify_request, + build_device_network_retrieve_request, + build_number_verification_verify_with_code_request, + build_number_verification_verify_without_code_request, + build_sim_swap_retrieve_request, + build_sim_swap_verify_request, +) + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class DeviceLocationOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.programmableconnectivity.aio.ProgrammableConnectivityClient`'s + :attr:`device_location` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + async def verify( + self, + body: _models.DeviceLocationVerificationContent, + *, + apc_gateway_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.DeviceLocationVerificationResult: + # pylint: disable=line-too-long + """Verifies whether a device is within a specified location area, defined as an accuracy (radius) + around a point, specified by longitude and latitude. + + :param body: Required. + :type body: ~azure.programmableconnectivity.models.DeviceLocationVerificationContent + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: DeviceLocationVerificationResult. The DeviceLocationVerificationResult is compatible + with MutableMapping + :rtype: ~azure.programmableconnectivity.models.DeviceLocationVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "accuracy": 0, # Accuracy expected for location verification in kilometers. + Required. + "device": { + "ipv4Address": { + "ipv4": "str", # An IPv4 address. This may be specified as + an exact address, or as a subnet in CIDR notation. Required. + "port": 0 # User equipment port. Required. + }, + "ipv6Address": { + "ipv6": "str", # An IPv6 address. This may be specified as + an exact address, or as a subnet in CIDR notation. Required. + "port": 0 # User equipment port. Required. + }, + "networkAccessIdentifier": "str", # Optional. External identifier or + network access identifier of the device. + "phoneNumber": "str" # Optional. Phone number in E.164 format + (starting with country code), and optionally prefixed with '+'. + }, + "latitude": 0.0, # Latitude of location to be verified. Required. + "longitude": 0.0, # Longitude of location to be verified. Required. + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + } + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the location is in the specified area, + False otherwise. Required. + } + """ + + @overload + async def verify( + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.DeviceLocationVerificationResult: + """Verifies whether a device is within a specified location area, defined as an accuracy (radius) + around a point, specified by longitude and latitude. + + :param body: Required. + :type body: JSON + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: DeviceLocationVerificationResult. The DeviceLocationVerificationResult is compatible + with MutableMapping + :rtype: ~azure.programmableconnectivity.models.DeviceLocationVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the location is in the specified area, + False otherwise. Required. + } + """ + + @overload + async def verify( + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.DeviceLocationVerificationResult: + """Verifies whether a device is within a specified location area, defined as an accuracy (radius) + around a point, specified by longitude and latitude. + + :param body: Required. + :type body: IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: DeviceLocationVerificationResult. The DeviceLocationVerificationResult is compatible + with MutableMapping + :rtype: ~azure.programmableconnectivity.models.DeviceLocationVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the location is in the specified area, + False otherwise. Required. + } + """ + + @distributed_trace_async + async def verify( + self, + body: Union[_models.DeviceLocationVerificationContent, JSON, IO[bytes]], + *, + apc_gateway_id: str, + **kwargs: Any + ) -> _models.DeviceLocationVerificationResult: + # pylint: disable=line-too-long + """Verifies whether a device is within a specified location area, defined as an accuracy (radius) + around a point, specified by longitude and latitude. + + :param body: Is one of the following types: DeviceLocationVerificationContent, JSON, IO[bytes] + Required. + :type body: ~azure.programmableconnectivity.models.DeviceLocationVerificationContent or JSON or + IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :return: DeviceLocationVerificationResult. The DeviceLocationVerificationResult is compatible + with MutableMapping + :rtype: ~azure.programmableconnectivity.models.DeviceLocationVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "accuracy": 0, # Accuracy expected for location verification in kilometers. + Required. + "device": { + "ipv4Address": { + "ipv4": "str", # An IPv4 address. This may be specified as + an exact address, or as a subnet in CIDR notation. Required. + "port": 0 # User equipment port. Required. + }, + "ipv6Address": { + "ipv6": "str", # An IPv6 address. This may be specified as + an exact address, or as a subnet in CIDR notation. Required. + "port": 0 # User equipment port. Required. + }, + "networkAccessIdentifier": "str", # Optional. External identifier or + network access identifier of the device. + "phoneNumber": "str" # Optional. Phone number in E.164 format + (starting with country code), and optionally prefixed with '+'. + }, + "latitude": 0.0, # Latitude of location to be verified. Required. + "longitude": 0.0, # Longitude of location to be verified. Required. + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + } + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the location is in the specified area, + False otherwise. Required. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeviceLocationVerificationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_device_location_verify_request( + apc_gateway_id=apc_gateway_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + response_headers["x-ms-request-id"] = self._deserialize("str", response.headers.get("x-ms-request-id")) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.DeviceLocationVerificationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + +class DeviceNetworkOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.programmableconnectivity.aio.ProgrammableConnectivityClient`'s + :attr:`device_network` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + async def retrieve( + self, + body: _models.NetworkIdentifier, + *, + apc_gateway_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.NetworkRetrievalResult: + # pylint: disable=line-too-long + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Required. + :type body: ~azure.programmableconnectivity.models.NetworkIdentifier + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: NetworkRetrievalResult. The NetworkRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.NetworkRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "identifier": "str", # The network identifier, based on the identifierType: + an IPv4 address, and IPv6 address, or a Network Code. A Network Code may be + obtained from APC documentation or from the APC /Network:retrieve endpoint. + Required. + "identifierType": "str" # The type of identifier for the network. one of: + 'IPv4', 'IPv6', 'NetworkCode'. Required. + } + + # response body for status code(s): 200 + response == { + "networkCode": "str" # The identifier for the network. This can be used as + the networkIdentifier for the service APIs. Required. + } + """ + + @overload + async def retrieve( + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.NetworkRetrievalResult: + # pylint: disable=line-too-long + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Required. + :type body: JSON + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: NetworkRetrievalResult. The NetworkRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.NetworkRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "networkCode": "str" # The identifier for the network. This can be used as + the networkIdentifier for the service APIs. Required. + } + """ + + @overload + async def retrieve( + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.NetworkRetrievalResult: + # pylint: disable=line-too-long + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Required. + :type body: IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: NetworkRetrievalResult. The NetworkRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.NetworkRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "networkCode": "str" # The identifier for the network. This can be used as + the networkIdentifier for the service APIs. Required. + } + """ + + @distributed_trace_async + async def retrieve( + self, body: Union[_models.NetworkIdentifier, JSON, IO[bytes]], *, apc_gateway_id: str, **kwargs: Any + ) -> _models.NetworkRetrievalResult: + # pylint: disable=line-too-long + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Is one of the following types: NetworkIdentifier, JSON, IO[bytes] Required. + :type body: ~azure.programmableconnectivity.models.NetworkIdentifier or JSON or IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :return: NetworkRetrievalResult. The NetworkRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.NetworkRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "identifier": "str", # The network identifier, based on the identifierType: + an IPv4 address, and IPv6 address, or a Network Code. A Network Code may be + obtained from APC documentation or from the APC /Network:retrieve endpoint. + Required. + "identifierType": "str" # The type of identifier for the network. one of: + 'IPv4', 'IPv6', 'NetworkCode'. Required. + } + + # response body for status code(s): 200 + response == { + "networkCode": "str" # The identifier for the network. This can be used as + the networkIdentifier for the service APIs. Required. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.NetworkRetrievalResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_device_network_retrieve_request( + apc_gateway_id=apc_gateway_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + response_headers["x-ms-request-id"] = self._deserialize("str", response.headers.get("x-ms-request-id")) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.NetworkRetrievalResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + +class NumberVerificationOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.programmableconnectivity.aio.ProgrammableConnectivityClient`'s + :attr:`number_verification` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + async def verify_without_code( # pylint: disable=inconsistent-return-statements + self, + body: _models.NumberVerificationWithoutCodeContent, + *, + apc_gateway_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Verifies the phone number (MSISDN) associated with a device. As part of the frontend + authorization flow, the device is redirected to the operator network to authenticate directly. + + :param body: Required. + :type body: ~azure.programmableconnectivity.models.NumberVerificationWithoutCodeContent + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "hashedPhoneNumber": "str", # Optional. Hashed phone number. SHA-256 (in + hexadecimal representation) of the mobile phone number in **E.164 format + (starting with country code)**. Optionally prefixed with '+'. + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + """ + + @overload + async def verify_without_code( # pylint: disable=inconsistent-return-statements + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Verifies the phone number (MSISDN) associated with a device. As part of the frontend + authorization flow, the device is redirected to the operator network to authenticate directly. + + :param body: Required. + :type body: JSON + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def verify_without_code( # pylint: disable=inconsistent-return-statements + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Verifies the phone number (MSISDN) associated with a device. As part of the frontend + authorization flow, the device is redirected to the operator network to authenticate directly. + + :param body: Required. + :type body: IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def verify_without_code( # pylint: disable=inconsistent-return-statements + self, + body: Union[_models.NumberVerificationWithoutCodeContent, JSON, IO[bytes]], + *, + apc_gateway_id: str, + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Verifies the phone number (MSISDN) associated with a device. As part of the frontend + authorization flow, the device is redirected to the operator network to authenticate directly. + + :param body: Is one of the following types: NumberVerificationWithoutCodeContent, JSON, + IO[bytes] Required. + :type body: ~azure.programmableconnectivity.models.NumberVerificationWithoutCodeContent or JSON + or IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "hashedPhoneNumber": "str", # Optional. Hashed phone number. SHA-256 (in + hexadecimal representation) of the mobile phone number in **E.164 format + (starting with country code)**. Optionally prefixed with '+'. + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_number_verification_verify_without_code_request( + apc_gateway_id=apc_gateway_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [302]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["location"] = self._deserialize("str", response.headers.get("location")) + response_headers["x-ms-request-id"] = self._deserialize("str", response.headers.get("x-ms-request-id")) + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if cls: + return cls(pipeline_response, None, response_headers) # type: ignore + + @overload + async def verify_with_code( + self, + body: _models.NumberVerificationWithCodeContent, + *, + apc_gateway_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.NumberVerificationResult: + # pylint: disable=line-too-long + """Verifies the phone number (MSISDN) associated with a device. + + :param body: Required. + :type body: ~azure.programmableconnectivity.models.NumberVerificationWithCodeContent + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: NumberVerificationResult. The NumberVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.NumberVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "apcCode": "str", # The code provided by APC in exchange for the operator + code. Required. + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "hashedPhoneNumber": "str", # Optional. Hashed phone number. SHA-256 (in + hexadecimal representation) of the mobile phone number in **E.164 format + (starting with country code)**. Optionally prefixed with '+'. + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if number if the phone number matches the + device, False otherwise. Required. + } + """ + + @overload + async def verify_with_code( + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.NumberVerificationResult: + """Verifies the phone number (MSISDN) associated with a device. + + :param body: Required. + :type body: JSON + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: NumberVerificationResult. The NumberVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.NumberVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if number if the phone number matches the + device, False otherwise. Required. + } + """ + + @overload + async def verify_with_code( + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.NumberVerificationResult: + """Verifies the phone number (MSISDN) associated with a device. + + :param body: Required. + :type body: IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: NumberVerificationResult. The NumberVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.NumberVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if number if the phone number matches the + device, False otherwise. Required. + } + """ + + @distributed_trace_async + async def verify_with_code( + self, + body: Union[_models.NumberVerificationWithCodeContent, JSON, IO[bytes]], + *, + apc_gateway_id: str, + **kwargs: Any + ) -> _models.NumberVerificationResult: + # pylint: disable=line-too-long + """Verifies the phone number (MSISDN) associated with a device. + + :param body: Is one of the following types: NumberVerificationWithCodeContent, JSON, IO[bytes] + Required. + :type body: ~azure.programmableconnectivity.models.NumberVerificationWithCodeContent or JSON or + IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :return: NumberVerificationResult. The NumberVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.NumberVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "apcCode": "str", # The code provided by APC in exchange for the operator + code. Required. + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "hashedPhoneNumber": "str", # Optional. Hashed phone number. SHA-256 (in + hexadecimal representation) of the mobile phone number in **E.164 format + (starting with country code)**. Optionally prefixed with '+'. + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if number if the phone number matches the + device, False otherwise. Required. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.NumberVerificationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_number_verification_verify_with_code_request( + apc_gateway_id=apc_gateway_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + response_headers["x-ms-request-id"] = self._deserialize("str", response.headers.get("x-ms-request-id")) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.NumberVerificationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + +class SimSwapOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.programmableconnectivity.aio.ProgrammableConnectivityClient`'s + :attr:`sim_swap` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + async def retrieve( + self, + body: _models.SimSwapRetrievalContent, + *, + apc_gateway_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.SimSwapRetrievalResult: + # pylint: disable=line-too-long + """Provides timestamp of latest SIM swap. + + :param body: Required. + :type body: ~azure.programmableconnectivity.models.SimSwapRetrievalContent + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SimSwapRetrievalResult. The SimSwapRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + + # response body for status code(s): 200 + response == { + "date": "2020-02-20 00:00:00" # Datetime of most recent swap for SIM. + Required. + } + """ + + @overload + async def retrieve( + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.SimSwapRetrievalResult: + """Provides timestamp of latest SIM swap. + + :param body: Required. + :type body: JSON + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SimSwapRetrievalResult. The SimSwapRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "date": "2020-02-20 00:00:00" # Datetime of most recent swap for SIM. + Required. + } + """ + + @overload + async def retrieve( + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.SimSwapRetrievalResult: + """Provides timestamp of latest SIM swap. + + :param body: Required. + :type body: IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: SimSwapRetrievalResult. The SimSwapRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "date": "2020-02-20 00:00:00" # Datetime of most recent swap for SIM. + Required. + } + """ + + @distributed_trace_async + async def retrieve( + self, body: Union[_models.SimSwapRetrievalContent, JSON, IO[bytes]], *, apc_gateway_id: str, **kwargs: Any + ) -> _models.SimSwapRetrievalResult: + # pylint: disable=line-too-long + """Provides timestamp of latest SIM swap. + + :param body: Is one of the following types: SimSwapRetrievalContent, JSON, IO[bytes] Required. + :type body: ~azure.programmableconnectivity.models.SimSwapRetrievalContent or JSON or IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :return: SimSwapRetrievalResult. The SimSwapRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + + # response body for status code(s): 200 + response == { + "date": "2020-02-20 00:00:00" # Datetime of most recent swap for SIM. + Required. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.SimSwapRetrievalResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_sim_swap_retrieve_request( + apc_gateway_id=apc_gateway_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + response_headers["x-ms-request-id"] = self._deserialize("str", response.headers.get("x-ms-request-id")) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.SimSwapRetrievalResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + async def verify( + self, + body: _models.SimSwapVerificationContent, + *, + apc_gateway_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.SimSwapVerificationResult: + # pylint: disable=line-too-long + """Verifies if a SIM swap has been performed during a past period (defined in the request with + 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured. + + :param body: Required. + :type body: ~azure.programmableconnectivity.models.SimSwapVerificationContent + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SimSwapVerificationResult. The SimSwapVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "maxAgeHours": 0, # Optional. Maximum lookback for SimSwap verification. + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the SIM has swapped in the specified + period, False otherwise. Required. + } + """ + + @overload + async def verify( + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.SimSwapVerificationResult: + """Verifies if a SIM swap has been performed during a past period (defined in the request with + 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured. + + :param body: Required. + :type body: JSON + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SimSwapVerificationResult. The SimSwapVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the SIM has swapped in the specified + period, False otherwise. Required. + } + """ + + @overload + async def verify( + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.SimSwapVerificationResult: + """Verifies if a SIM swap has been performed during a past period (defined in the request with + 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured. + + :param body: Required. + :type body: IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: SimSwapVerificationResult. The SimSwapVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the SIM has swapped in the specified + period, False otherwise. Required. + } + """ + + @distributed_trace_async + async def verify( + self, body: Union[_models.SimSwapVerificationContent, JSON, IO[bytes]], *, apc_gateway_id: str, **kwargs: Any + ) -> _models.SimSwapVerificationResult: + # pylint: disable=line-too-long + """Verifies if a SIM swap has been performed during a past period (defined in the request with + 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured. + + :param body: Is one of the following types: SimSwapVerificationContent, JSON, IO[bytes] + Required. + :type body: ~azure.programmableconnectivity.models.SimSwapVerificationContent or JSON or + IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :return: SimSwapVerificationResult. The SimSwapVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "maxAgeHours": 0, # Optional. Maximum lookback for SimSwap verification. + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the SIM has swapped in the specified + period, False otherwise. Required. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.SimSwapVerificationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_sim_swap_verify_request( + apc_gateway_id=apc_gateway_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + response_headers["x-ms-request-id"] = self._deserialize("str", response.headers.get("x-ms-request-id")) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.SimSwapVerificationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/operations/_patch.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/models/__init__.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/models/__init__.py new file mode 100644 index 000000000000..331b8ab93236 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/models/__init__.py @@ -0,0 +1,44 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import DeviceLocationVerificationContent +from ._models import DeviceLocationVerificationResult +from ._models import Ipv4Address +from ._models import Ipv6Address +from ._models import LocationDevice +from ._models import NetworkIdentifier +from ._models import NetworkRetrievalResult +from ._models import NumberVerificationResult +from ._models import NumberVerificationWithCodeContent +from ._models import NumberVerificationWithoutCodeContent +from ._models import SimSwapRetrievalContent +from ._models import SimSwapRetrievalResult +from ._models import SimSwapVerificationContent +from ._models import SimSwapVerificationResult +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DeviceLocationVerificationContent", + "DeviceLocationVerificationResult", + "Ipv4Address", + "Ipv6Address", + "LocationDevice", + "NetworkIdentifier", + "NetworkRetrievalResult", + "NumberVerificationResult", + "NumberVerificationWithCodeContent", + "NumberVerificationWithoutCodeContent", + "SimSwapRetrievalContent", + "SimSwapRetrievalResult", + "SimSwapVerificationContent", + "SimSwapVerificationResult", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/models/_models.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/models/_models.py new file mode 100644 index 000000000000..e8b2f4eaf382 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/models/_models.py @@ -0,0 +1,572 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +import datetime +from typing import Any, Mapping, Optional, TYPE_CHECKING, overload + +from .. import _model_base +from .._model_base import rest_field + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from .. import models as _models + + +class DeviceLocationVerificationContent(_model_base.Model): + """Request to verify Location. + + All required parameters must be populated in order to send to server. + + :ivar network_identifier: Network to query for this device, or device information to enable + network routing. Required. + :vartype network_identifier: ~azure.programmableconnectivity.models.NetworkIdentifier + :ivar latitude: Latitude of location to be verified. Required. + :vartype latitude: float + :ivar longitude: Longitude of location to be verified. Required. + :vartype longitude: float + :ivar accuracy: Accuracy expected for location verification in kilometers. Required. + :vartype accuracy: int + :ivar device: The device to find the location for. Exactly one of Network Access Code, Phone + Number, IPv4 address, or IPv6 address. Required. + :vartype device: ~azure.programmableconnectivity.models.LocationDevice + """ + + network_identifier: "_models.NetworkIdentifier" = rest_field(name="networkIdentifier") + """Network to query for this device, or device information to enable network routing. Required.""" + latitude: float = rest_field() + """Latitude of location to be verified. Required.""" + longitude: float = rest_field() + """Longitude of location to be verified. Required.""" + accuracy: int = rest_field() + """Accuracy expected for location verification in kilometers. Required.""" + device: "_models.LocationDevice" = rest_field() + """The device to find the location for. Exactly one of Network Access Code, Phone Number, IPv4 + address, or IPv6 address. Required.""" + + @overload + def __init__( + self, + *, + network_identifier: "_models.NetworkIdentifier", + latitude: float, + longitude: float, + accuracy: int, + device: "_models.LocationDevice", + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DeviceLocationVerificationResult(_model_base.Model): + """Response verifying location. + + All required parameters must be populated in order to send to server. + + :ivar verification_result: True if the location is in the specified area, False otherwise. + Required. + :vartype verification_result: bool + """ + + verification_result: bool = rest_field(name="verificationResult") + """True if the location is in the specified area, False otherwise. Required.""" + + @overload + def __init__( + self, + *, + verification_result: bool, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Ipv4Address(_model_base.Model): + """IPv4 device indicator. + + All required parameters must be populated in order to send to server. + + :ivar ipv4: An IPv4 address. This may be specified as an exact address, or as a subnet in CIDR + notation. Required. + :vartype ipv4: str + :ivar port: User equipment port. Required. + :vartype port: int + """ + + ipv4: str = rest_field() + """An IPv4 address. This may be specified as an exact address, or as a subnet in CIDR notation. + Required.""" + port: int = rest_field() + """User equipment port. Required.""" + + @overload + def __init__( + self, + *, + ipv4: str, + port: int, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Ipv6Address(_model_base.Model): + """IPv6 device indicator. + + All required parameters must be populated in order to send to server. + + :ivar ipv6: An IPv6 address. This may be specified as an exact address, or as a subnet in CIDR + notation. Required. + :vartype ipv6: str + :ivar port: User equipment port. Required. + :vartype port: int + """ + + ipv6: str = rest_field() + """An IPv6 address. This may be specified as an exact address, or as a subnet in CIDR notation. + Required.""" + port: int = rest_field() + """User equipment port. Required.""" + + @overload + def __init__( + self, + *, + ipv6: str, + port: int, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class LocationDevice(_model_base.Model): + """Device information needed by operator to provide location information. Include exactly one of + these properties to identify your device. + + :ivar network_access_identifier: External identifier or network access identifier of the + device. + :vartype network_access_identifier: str + :ivar phone_number: Phone number in E.164 format (starting with country code), and optionally + prefixed with '+'. + :vartype phone_number: str + :ivar ipv4_address: The Ipv4 address. + :vartype ipv4_address: ~azure.programmableconnectivity.models.Ipv4Address + :ivar ipv6_address: The Ipv6 address. + :vartype ipv6_address: ~azure.programmableconnectivity.models.Ipv6Address + """ + + network_access_identifier: Optional[str] = rest_field(name="networkAccessIdentifier") + """External identifier or network access identifier of the device.""" + phone_number: Optional[str] = rest_field(name="phoneNumber") + """Phone number in E.164 format (starting with country code), and optionally prefixed with '+'.""" + ipv4_address: Optional["_models.Ipv4Address"] = rest_field(name="ipv4Address") + """The Ipv4 address.""" + ipv6_address: Optional["_models.Ipv6Address"] = rest_field(name="ipv6Address") + """The Ipv6 address.""" + + @overload + def __init__( + self, + *, + network_access_identifier: Optional[str] = None, + phone_number: Optional[str] = None, + ipv4_address: Optional["_models.Ipv4Address"] = None, + ipv6_address: Optional["_models.Ipv6Address"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class NetworkIdentifier(_model_base.Model): + """Identifier for the network to be queried. + + All required parameters must be populated in order to send to server. + + :ivar identifier_type: The type of identifier for the network. one of: 'IPv4', 'IPv6', + 'NetworkCode'. Required. + :vartype identifier_type: str + :ivar identifier: The network identifier, based on the identifierType: an IPv4 address, and + IPv6 address, or a Network Code. + A Network Code may be obtained from APC documentation or from the APC /Network:retrieve + endpoint. Required. + :vartype identifier: str + """ + + identifier_type: str = rest_field(name="identifierType") + """The type of identifier for the network. one of: 'IPv4', 'IPv6', 'NetworkCode'. Required.""" + identifier: str = rest_field() + """The network identifier, based on the identifierType: an IPv4 address, and IPv6 address, or a + Network Code. + A Network Code may be obtained from APC documentation or from the APC /Network:retrieve + endpoint. Required.""" + + @overload + def __init__( + self, + *, + identifier_type: str, + identifier: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class NetworkRetrievalResult(_model_base.Model): + """The network that the device is on. + + All required parameters must be populated in order to send to server. + + :ivar network_code: The identifier for the network. This can be used as the networkIdentifier + for the service APIs. Required. + :vartype network_code: str + """ + + network_code: str = rest_field(name="networkCode") + """The identifier for the network. This can be used as the networkIdentifier for the service APIs. + Required.""" + + @overload + def __init__( + self, + *, + network_code: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class NumberVerificationResult(_model_base.Model): + """Response verifying number of device. + + All required parameters must be populated in order to send to server. + + :ivar verification_result: True if number if the phone number matches the device, False + otherwise. Required. + :vartype verification_result: bool + """ + + verification_result: bool = rest_field(name="verificationResult") + """True if number if the phone number matches the device, False otherwise. Required.""" + + @overload + def __init__( + self, + *, + verification_result: bool, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class NumberVerificationWithCodeContent(_model_base.Model): + """Request to verify number of device - second call. + + All required parameters must be populated in order to send to server. + + :ivar network_identifier: Identifier for the network to query for this device. Required. + :vartype network_identifier: ~azure.programmableconnectivity.models.NetworkIdentifier + :ivar phone_number: Phone number in E.164 format (starting with country code), and optionally + prefixed with '+'. + :vartype phone_number: str + :ivar hashed_phone_number: Hashed phone number. SHA-256 (in hexadecimal representation) of the + mobile phone number in **E.164 format (starting with country code)**. Optionally prefixed with + '+'. + :vartype hashed_phone_number: str + :ivar apc_code: The code provided by APC in exchange for the operator code. Required. + :vartype apc_code: str + """ + + network_identifier: "_models.NetworkIdentifier" = rest_field(name="networkIdentifier") + """Identifier for the network to query for this device. Required.""" + phone_number: Optional[str] = rest_field(name="phoneNumber") + """Phone number in E.164 format (starting with country code), and optionally prefixed with '+'.""" + hashed_phone_number: Optional[str] = rest_field(name="hashedPhoneNumber") + """Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in + **E.164 format (starting with country code)**. Optionally prefixed with '+'.""" + apc_code: str = rest_field(name="apcCode") + """The code provided by APC in exchange for the operator code. Required.""" + + @overload + def __init__( + self, + *, + network_identifier: "_models.NetworkIdentifier", + apc_code: str, + phone_number: Optional[str] = None, + hashed_phone_number: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class NumberVerificationWithoutCodeContent(_model_base.Model): + """Request to verify number of device - first call. + + All required parameters must be populated in order to send to server. + + :ivar network_identifier: Identifier for the network to query for this device. Required. + :vartype network_identifier: ~azure.programmableconnectivity.models.NetworkIdentifier + :ivar phone_number: Phone number in E.164 format (starting with country code), and optionally + prefixed with '+'. + :vartype phone_number: str + :ivar hashed_phone_number: Hashed phone number. SHA-256 (in hexadecimal representation) of the + mobile phone number in **E.164 format (starting with country code)**. Optionally prefixed with + '+'. + :vartype hashed_phone_number: str + """ + + network_identifier: "_models.NetworkIdentifier" = rest_field(name="networkIdentifier") + """Identifier for the network to query for this device. Required.""" + phone_number: Optional[str] = rest_field(name="phoneNumber") + """Phone number in E.164 format (starting with country code), and optionally prefixed with '+'.""" + hashed_phone_number: Optional[str] = rest_field(name="hashedPhoneNumber") + """Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in + **E.164 format (starting with country code)**. Optionally prefixed with '+'.""" + + @overload + def __init__( + self, + *, + network_identifier: "_models.NetworkIdentifier", + phone_number: Optional[str] = None, + hashed_phone_number: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SimSwapRetrievalContent(_model_base.Model): + """Request to retrieve SimSwap date. + + All required parameters must be populated in order to send to server. + + :ivar phone_number: Phone number in E.164 format (starting with country code), and optionally + prefixed with '+'. + :vartype phone_number: str + :ivar network_identifier: Network to query for this device. Required. + :vartype network_identifier: ~azure.programmableconnectivity.models.NetworkIdentifier + """ + + phone_number: Optional[str] = rest_field(name="phoneNumber") + """Phone number in E.164 format (starting with country code), and optionally prefixed with '+'.""" + network_identifier: "_models.NetworkIdentifier" = rest_field(name="networkIdentifier") + """Network to query for this device. Required.""" + + @overload + def __init__( + self, + *, + network_identifier: "_models.NetworkIdentifier", + phone_number: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SimSwapRetrievalResult(_model_base.Model): + """Response with SimSwap date. + + All required parameters must be populated in order to send to server. + + :ivar date: Datetime of most recent swap for SIM. Required. + :vartype date: ~datetime.datetime + """ + + date: datetime.datetime = rest_field(format="rfc3339") + """Datetime of most recent swap for SIM. Required.""" + + @overload + def __init__( + self, + *, + date: datetime.datetime, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SimSwapVerificationContent(_model_base.Model): + """Request to verify SimSwap in period. + + All required parameters must be populated in order to send to server. + + :ivar phone_number: Phone number in E.164 format (starting with country code), and optionally + prefixed with '+'. + :vartype phone_number: str + :ivar max_age_hours: Maximum lookback for SimSwap verification. + :vartype max_age_hours: int + :ivar network_identifier: Identifier for the network to query for this device. Required. + :vartype network_identifier: ~azure.programmableconnectivity.models.NetworkIdentifier + """ + + phone_number: Optional[str] = rest_field(name="phoneNumber") + """Phone number in E.164 format (starting with country code), and optionally prefixed with '+'.""" + max_age_hours: Optional[int] = rest_field(name="maxAgeHours") + """Maximum lookback for SimSwap verification.""" + network_identifier: "_models.NetworkIdentifier" = rest_field(name="networkIdentifier") + """Identifier for the network to query for this device. Required.""" + + @overload + def __init__( + self, + *, + network_identifier: "_models.NetworkIdentifier", + phone_number: Optional[str] = None, + max_age_hours: Optional[int] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SimSwapVerificationResult(_model_base.Model): + """Response verifying SimSwap in period. + + All required parameters must be populated in order to send to server. + + :ivar verification_result: True if the SIM has swapped in the specified period, False + otherwise. Required. + :vartype verification_result: bool + """ + + verification_result: bool = rest_field(name="verificationResult") + """True if the SIM has swapped in the specified period, False otherwise. Required.""" + + @overload + def __init__( + self, + *, + verification_result: bool, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/models/_patch.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/models/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/models/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/operations/__init__.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/operations/__init__.py new file mode 100644 index 000000000000..438712907b24 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/operations/__init__.py @@ -0,0 +1,25 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import DeviceLocationOperations +from ._operations import DeviceNetworkOperations +from ._operations import NumberVerificationOperations +from ._operations import SimSwapOperations + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DeviceLocationOperations", + "DeviceNetworkOperations", + "NumberVerificationOperations", + "SimSwapOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/operations/_operations.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/operations/_operations.py new file mode 100644 index 000000000000..dbf470de1c5c --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/operations/_operations.py @@ -0,0 +1,1547 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._model_base import SdkJSONEncoder, _deserialize +from .._serialization import Serializer + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_device_location_verify_request(*, apc_gateway_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-02-09-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/device-location/location:verify" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["apc-gateway-id"] = _SERIALIZER.header("apc_gateway_id", apc_gateway_id, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_device_network_retrieve_request(*, apc_gateway_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-02-09-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/device-network/network:retrieve" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["apc-gateway-id"] = _SERIALIZER.header("apc_gateway_id", apc_gateway_id, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_number_verification_verify_without_code_request( # pylint: disable=name-too-long + *, apc_gateway_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-02-09-preview")) + # Construct URL + _url = "/number-verification/number:verify" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["apc-gateway-id"] = _SERIALIZER.header("apc_gateway_id", apc_gateway_id, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_number_verification_verify_with_code_request( # pylint: disable=name-too-long + *, apc_gateway_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-02-09-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/number-verification/number:verify" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["apc-gateway-id"] = _SERIALIZER.header("apc_gateway_id", apc_gateway_id, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_sim_swap_retrieve_request(*, apc_gateway_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-02-09-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/sim-swap/sim-swap:retrieve" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["apc-gateway-id"] = _SERIALIZER.header("apc_gateway_id", apc_gateway_id, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_sim_swap_verify_request(*, apc_gateway_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-02-09-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/sim-swap/sim-swap:verify" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["apc-gateway-id"] = _SERIALIZER.header("apc_gateway_id", apc_gateway_id, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +class DeviceLocationOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.programmableconnectivity.ProgrammableConnectivityClient`'s + :attr:`device_location` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def verify( + self, + body: _models.DeviceLocationVerificationContent, + *, + apc_gateway_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.DeviceLocationVerificationResult: + # pylint: disable=line-too-long + """Verifies whether a device is within a specified location area, defined as an accuracy (radius) + around a point, specified by longitude and latitude. + + :param body: Required. + :type body: ~azure.programmableconnectivity.models.DeviceLocationVerificationContent + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: DeviceLocationVerificationResult. The DeviceLocationVerificationResult is compatible + with MutableMapping + :rtype: ~azure.programmableconnectivity.models.DeviceLocationVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "accuracy": 0, # Accuracy expected for location verification in kilometers. + Required. + "device": { + "ipv4Address": { + "ipv4": "str", # An IPv4 address. This may be specified as + an exact address, or as a subnet in CIDR notation. Required. + "port": 0 # User equipment port. Required. + }, + "ipv6Address": { + "ipv6": "str", # An IPv6 address. This may be specified as + an exact address, or as a subnet in CIDR notation. Required. + "port": 0 # User equipment port. Required. + }, + "networkAccessIdentifier": "str", # Optional. External identifier or + network access identifier of the device. + "phoneNumber": "str" # Optional. Phone number in E.164 format + (starting with country code), and optionally prefixed with '+'. + }, + "latitude": 0.0, # Latitude of location to be verified. Required. + "longitude": 0.0, # Longitude of location to be verified. Required. + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + } + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the location is in the specified area, + False otherwise. Required. + } + """ + + @overload + def verify( + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.DeviceLocationVerificationResult: + """Verifies whether a device is within a specified location area, defined as an accuracy (radius) + around a point, specified by longitude and latitude. + + :param body: Required. + :type body: JSON + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: DeviceLocationVerificationResult. The DeviceLocationVerificationResult is compatible + with MutableMapping + :rtype: ~azure.programmableconnectivity.models.DeviceLocationVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the location is in the specified area, + False otherwise. Required. + } + """ + + @overload + def verify( + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.DeviceLocationVerificationResult: + """Verifies whether a device is within a specified location area, defined as an accuracy (radius) + around a point, specified by longitude and latitude. + + :param body: Required. + :type body: IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: DeviceLocationVerificationResult. The DeviceLocationVerificationResult is compatible + with MutableMapping + :rtype: ~azure.programmableconnectivity.models.DeviceLocationVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the location is in the specified area, + False otherwise. Required. + } + """ + + @distributed_trace + def verify( + self, + body: Union[_models.DeviceLocationVerificationContent, JSON, IO[bytes]], + *, + apc_gateway_id: str, + **kwargs: Any + ) -> _models.DeviceLocationVerificationResult: + # pylint: disable=line-too-long + """Verifies whether a device is within a specified location area, defined as an accuracy (radius) + around a point, specified by longitude and latitude. + + :param body: Is one of the following types: DeviceLocationVerificationContent, JSON, IO[bytes] + Required. + :type body: ~azure.programmableconnectivity.models.DeviceLocationVerificationContent or JSON or + IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :return: DeviceLocationVerificationResult. The DeviceLocationVerificationResult is compatible + with MutableMapping + :rtype: ~azure.programmableconnectivity.models.DeviceLocationVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "accuracy": 0, # Accuracy expected for location verification in kilometers. + Required. + "device": { + "ipv4Address": { + "ipv4": "str", # An IPv4 address. This may be specified as + an exact address, or as a subnet in CIDR notation. Required. + "port": 0 # User equipment port. Required. + }, + "ipv6Address": { + "ipv6": "str", # An IPv6 address. This may be specified as + an exact address, or as a subnet in CIDR notation. Required. + "port": 0 # User equipment port. Required. + }, + "networkAccessIdentifier": "str", # Optional. External identifier or + network access identifier of the device. + "phoneNumber": "str" # Optional. Phone number in E.164 format + (starting with country code), and optionally prefixed with '+'. + }, + "latitude": 0.0, # Latitude of location to be verified. Required. + "longitude": 0.0, # Longitude of location to be verified. Required. + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + } + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the location is in the specified area, + False otherwise. Required. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeviceLocationVerificationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_device_location_verify_request( + apc_gateway_id=apc_gateway_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + response_headers["x-ms-request-id"] = self._deserialize("str", response.headers.get("x-ms-request-id")) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.DeviceLocationVerificationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + +class DeviceNetworkOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.programmableconnectivity.ProgrammableConnectivityClient`'s + :attr:`device_network` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def retrieve( + self, + body: _models.NetworkIdentifier, + *, + apc_gateway_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.NetworkRetrievalResult: + # pylint: disable=line-too-long + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Required. + :type body: ~azure.programmableconnectivity.models.NetworkIdentifier + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: NetworkRetrievalResult. The NetworkRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.NetworkRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "identifier": "str", # The network identifier, based on the identifierType: + an IPv4 address, and IPv6 address, or a Network Code. A Network Code may be + obtained from APC documentation or from the APC /Network:retrieve endpoint. + Required. + "identifierType": "str" # The type of identifier for the network. one of: + 'IPv4', 'IPv6', 'NetworkCode'. Required. + } + + # response body for status code(s): 200 + response == { + "networkCode": "str" # The identifier for the network. This can be used as + the networkIdentifier for the service APIs. Required. + } + """ + + @overload + def retrieve( + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.NetworkRetrievalResult: + # pylint: disable=line-too-long + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Required. + :type body: JSON + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: NetworkRetrievalResult. The NetworkRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.NetworkRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "networkCode": "str" # The identifier for the network. This can be used as + the networkIdentifier for the service APIs. Required. + } + """ + + @overload + def retrieve( + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.NetworkRetrievalResult: + # pylint: disable=line-too-long + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Required. + :type body: IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: NetworkRetrievalResult. The NetworkRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.NetworkRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "networkCode": "str" # The identifier for the network. This can be used as + the networkIdentifier for the service APIs. Required. + } + """ + + @distributed_trace + def retrieve( + self, body: Union[_models.NetworkIdentifier, JSON, IO[bytes]], *, apc_gateway_id: str, **kwargs: Any + ) -> _models.NetworkRetrievalResult: + # pylint: disable=line-too-long + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Is one of the following types: NetworkIdentifier, JSON, IO[bytes] Required. + :type body: ~azure.programmableconnectivity.models.NetworkIdentifier or JSON or IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :return: NetworkRetrievalResult. The NetworkRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.NetworkRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "identifier": "str", # The network identifier, based on the identifierType: + an IPv4 address, and IPv6 address, or a Network Code. A Network Code may be + obtained from APC documentation or from the APC /Network:retrieve endpoint. + Required. + "identifierType": "str" # The type of identifier for the network. one of: + 'IPv4', 'IPv6', 'NetworkCode'. Required. + } + + # response body for status code(s): 200 + response == { + "networkCode": "str" # The identifier for the network. This can be used as + the networkIdentifier for the service APIs. Required. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.NetworkRetrievalResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_device_network_retrieve_request( + apc_gateway_id=apc_gateway_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + response_headers["x-ms-request-id"] = self._deserialize("str", response.headers.get("x-ms-request-id")) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.NetworkRetrievalResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + +class NumberVerificationOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.programmableconnectivity.ProgrammableConnectivityClient`'s + :attr:`number_verification` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def verify_without_code( # pylint: disable=inconsistent-return-statements + self, + body: _models.NumberVerificationWithoutCodeContent, + *, + apc_gateway_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Verifies the phone number (MSISDN) associated with a device. As part of the frontend + authorization flow, the device is redirected to the operator network to authenticate directly. + + :param body: Required. + :type body: ~azure.programmableconnectivity.models.NumberVerificationWithoutCodeContent + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "hashedPhoneNumber": "str", # Optional. Hashed phone number. SHA-256 (in + hexadecimal representation) of the mobile phone number in **E.164 format + (starting with country code)**. Optionally prefixed with '+'. + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + """ + + @overload + def verify_without_code( # pylint: disable=inconsistent-return-statements + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Verifies the phone number (MSISDN) associated with a device. As part of the frontend + authorization flow, the device is redirected to the operator network to authenticate directly. + + :param body: Required. + :type body: JSON + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def verify_without_code( # pylint: disable=inconsistent-return-statements + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Verifies the phone number (MSISDN) associated with a device. As part of the frontend + authorization flow, the device is redirected to the operator network to authenticate directly. + + :param body: Required. + :type body: IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def verify_without_code( # pylint: disable=inconsistent-return-statements + self, + body: Union[_models.NumberVerificationWithoutCodeContent, JSON, IO[bytes]], + *, + apc_gateway_id: str, + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Verifies the phone number (MSISDN) associated with a device. As part of the frontend + authorization flow, the device is redirected to the operator network to authenticate directly. + + :param body: Is one of the following types: NumberVerificationWithoutCodeContent, JSON, + IO[bytes] Required. + :type body: ~azure.programmableconnectivity.models.NumberVerificationWithoutCodeContent or JSON + or IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "hashedPhoneNumber": "str", # Optional. Hashed phone number. SHA-256 (in + hexadecimal representation) of the mobile phone number in **E.164 format + (starting with country code)**. Optionally prefixed with '+'. + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_number_verification_verify_without_code_request( + apc_gateway_id=apc_gateway_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [302]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["location"] = self._deserialize("str", response.headers.get("location")) + response_headers["x-ms-request-id"] = self._deserialize("str", response.headers.get("x-ms-request-id")) + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if cls: + return cls(pipeline_response, None, response_headers) # type: ignore + + @overload + def verify_with_code( + self, + body: _models.NumberVerificationWithCodeContent, + *, + apc_gateway_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.NumberVerificationResult: + # pylint: disable=line-too-long + """Verifies the phone number (MSISDN) associated with a device. + + :param body: Required. + :type body: ~azure.programmableconnectivity.models.NumberVerificationWithCodeContent + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: NumberVerificationResult. The NumberVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.NumberVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "apcCode": "str", # The code provided by APC in exchange for the operator + code. Required. + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "hashedPhoneNumber": "str", # Optional. Hashed phone number. SHA-256 (in + hexadecimal representation) of the mobile phone number in **E.164 format + (starting with country code)**. Optionally prefixed with '+'. + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if number if the phone number matches the + device, False otherwise. Required. + } + """ + + @overload + def verify_with_code( + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.NumberVerificationResult: + """Verifies the phone number (MSISDN) associated with a device. + + :param body: Required. + :type body: JSON + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: NumberVerificationResult. The NumberVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.NumberVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if number if the phone number matches the + device, False otherwise. Required. + } + """ + + @overload + def verify_with_code( + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.NumberVerificationResult: + """Verifies the phone number (MSISDN) associated with a device. + + :param body: Required. + :type body: IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: NumberVerificationResult. The NumberVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.NumberVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if number if the phone number matches the + device, False otherwise. Required. + } + """ + + @distributed_trace + def verify_with_code( + self, + body: Union[_models.NumberVerificationWithCodeContent, JSON, IO[bytes]], + *, + apc_gateway_id: str, + **kwargs: Any + ) -> _models.NumberVerificationResult: + # pylint: disable=line-too-long + """Verifies the phone number (MSISDN) associated with a device. + + :param body: Is one of the following types: NumberVerificationWithCodeContent, JSON, IO[bytes] + Required. + :type body: ~azure.programmableconnectivity.models.NumberVerificationWithCodeContent or JSON or + IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :return: NumberVerificationResult. The NumberVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.NumberVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "apcCode": "str", # The code provided by APC in exchange for the operator + code. Required. + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "hashedPhoneNumber": "str", # Optional. Hashed phone number. SHA-256 (in + hexadecimal representation) of the mobile phone number in **E.164 format + (starting with country code)**. Optionally prefixed with '+'. + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if number if the phone number matches the + device, False otherwise. Required. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.NumberVerificationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_number_verification_verify_with_code_request( + apc_gateway_id=apc_gateway_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + response_headers["x-ms-request-id"] = self._deserialize("str", response.headers.get("x-ms-request-id")) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.NumberVerificationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + +class SimSwapOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.programmableconnectivity.ProgrammableConnectivityClient`'s + :attr:`sim_swap` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def retrieve( + self, + body: _models.SimSwapRetrievalContent, + *, + apc_gateway_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.SimSwapRetrievalResult: + # pylint: disable=line-too-long + """Provides timestamp of latest SIM swap. + + :param body: Required. + :type body: ~azure.programmableconnectivity.models.SimSwapRetrievalContent + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SimSwapRetrievalResult. The SimSwapRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + + # response body for status code(s): 200 + response == { + "date": "2020-02-20 00:00:00" # Datetime of most recent swap for SIM. + Required. + } + """ + + @overload + def retrieve( + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.SimSwapRetrievalResult: + """Provides timestamp of latest SIM swap. + + :param body: Required. + :type body: JSON + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SimSwapRetrievalResult. The SimSwapRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "date": "2020-02-20 00:00:00" # Datetime of most recent swap for SIM. + Required. + } + """ + + @overload + def retrieve( + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.SimSwapRetrievalResult: + """Provides timestamp of latest SIM swap. + + :param body: Required. + :type body: IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: SimSwapRetrievalResult. The SimSwapRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "date": "2020-02-20 00:00:00" # Datetime of most recent swap for SIM. + Required. + } + """ + + @distributed_trace + def retrieve( + self, body: Union[_models.SimSwapRetrievalContent, JSON, IO[bytes]], *, apc_gateway_id: str, **kwargs: Any + ) -> _models.SimSwapRetrievalResult: + # pylint: disable=line-too-long + """Provides timestamp of latest SIM swap. + + :param body: Is one of the following types: SimSwapRetrievalContent, JSON, IO[bytes] Required. + :type body: ~azure.programmableconnectivity.models.SimSwapRetrievalContent or JSON or IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :return: SimSwapRetrievalResult. The SimSwapRetrievalResult is compatible with MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapRetrievalResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + + # response body for status code(s): 200 + response == { + "date": "2020-02-20 00:00:00" # Datetime of most recent swap for SIM. + Required. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.SimSwapRetrievalResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_sim_swap_retrieve_request( + apc_gateway_id=apc_gateway_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + response_headers["x-ms-request-id"] = self._deserialize("str", response.headers.get("x-ms-request-id")) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.SimSwapRetrievalResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + def verify( + self, + body: _models.SimSwapVerificationContent, + *, + apc_gateway_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.SimSwapVerificationResult: + # pylint: disable=line-too-long + """Verifies if a SIM swap has been performed during a past period (defined in the request with + 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured. + + :param body: Required. + :type body: ~azure.programmableconnectivity.models.SimSwapVerificationContent + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SimSwapVerificationResult. The SimSwapVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "maxAgeHours": 0, # Optional. Maximum lookback for SimSwap verification. + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the SIM has swapped in the specified + period, False otherwise. Required. + } + """ + + @overload + def verify( + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.SimSwapVerificationResult: + """Verifies if a SIM swap has been performed during a past period (defined in the request with + 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured. + + :param body: Required. + :type body: JSON + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SimSwapVerificationResult. The SimSwapVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the SIM has swapped in the specified + period, False otherwise. Required. + } + """ + + @overload + def verify( + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.SimSwapVerificationResult: + """Verifies if a SIM swap has been performed during a past period (defined in the request with + 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured. + + :param body: Required. + :type body: IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: SimSwapVerificationResult. The SimSwapVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the SIM has swapped in the specified + period, False otherwise. Required. + } + """ + + @distributed_trace + def verify( + self, body: Union[_models.SimSwapVerificationContent, JSON, IO[bytes]], *, apc_gateway_id: str, **kwargs: Any + ) -> _models.SimSwapVerificationResult: + # pylint: disable=line-too-long + """Verifies if a SIM swap has been performed during a past period (defined in the request with + 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured. + + :param body: Is one of the following types: SimSwapVerificationContent, JSON, IO[bytes] + Required. + :type body: ~azure.programmableconnectivity.models.SimSwapVerificationContent or JSON or + IO[bytes] + :keyword apc_gateway_id: The identifier of the APC Gateway resource which should handle this + request. Required. + :paramtype apc_gateway_id: str + :return: SimSwapVerificationResult. The SimSwapVerificationResult is compatible with + MutableMapping + :rtype: ~azure.programmableconnectivity.models.SimSwapVerificationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "networkIdentifier": { + "identifier": "str", # The network identifier, based on the + identifierType: an IPv4 address, and IPv6 address, or a Network Code. A + Network Code may be obtained from APC documentation or from the APC + /Network:retrieve endpoint. Required. + "identifierType": "str" # The type of identifier for the network. + one of: 'IPv4', 'IPv6', 'NetworkCode'. Required. + }, + "maxAgeHours": 0, # Optional. Maximum lookback for SimSwap verification. + "phoneNumber": "str" # Optional. Phone number in E.164 format (starting with + country code), and optionally prefixed with '+'. + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool # True if the SIM has swapped in the specified + period, False otherwise. Required. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.SimSwapVerificationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_sim_swap_verify_request( + apc_gateway_id=apc_gateway_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + response_headers["x-ms-request-id"] = self._deserialize("str", response.headers.get("x-ms-request-id")) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.SimSwapVerificationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/operations/_patch.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/py.typed b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/dev_requirements.txt b/sdk/programmableconnectivity/azure-programmableconnectivity/dev_requirements.txt new file mode 100644 index 000000000000..c4e89ba26d71 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/dev_requirements.txt @@ -0,0 +1,5 @@ +-e ../../../tools/azure-devtools +-e ../../../tools/azure-sdk-tools +../../core/azure-core +../../identity/azure-identity +aiohttp \ No newline at end of file diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/sdk_packaging.toml b/sdk/programmableconnectivity/azure-programmableconnectivity/sdk_packaging.toml new file mode 100644 index 000000000000..e7687fdae93b --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/sdk_packaging.toml @@ -0,0 +1,2 @@ +[packaging] +auto_update = false \ No newline at end of file diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/setup.py b/sdk/programmableconnectivity/azure-programmableconnectivity/setup.py new file mode 100644 index 000000000000..304a1cfe49b4 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/setup.py @@ -0,0 +1,70 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# coding: utf-8 + +import os +import re +from setuptools import setup, find_packages + + +PACKAGE_NAME = "azure-programmableconnectivity" +PACKAGE_PPRINT_NAME = "Azure Programmableconnectivity" + +# a-b-c => a/b/c +package_folder_path = PACKAGE_NAME.replace("-", "/") + +# Version extraction inspired from 'requests' +with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: + version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) + +if not version: + raise RuntimeError("Cannot find version information") + + +setup( + name=PACKAGE_NAME, + version=version, + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), + long_description=open("README.md", "r").read(), + long_description_content_type="text/markdown", + license="MIT License", + author="Microsoft Corporation", + author_email="azpysdkhelp@microsoft.com", + url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", + keywords="azure, azure sdk", + classifiers=[ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "License :: OSI Approved :: MIT License", + ], + zip_safe=False, + packages=find_packages( + exclude=[ + "tests", + # Exclude packages that will be covered by PEP420 or nspkg + "azure", + ] + ), + include_package_data=True, + package_data={ + "azure.programmableconnectivity": ["py.typed"], + }, + install_requires=[ + "isodate<1.0.0,>=0.6.1", + "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", + ], + python_requires=">=3.8", +) diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/tsp-location.yaml b/sdk/programmableconnectivity/azure-programmableconnectivity/tsp-location.yaml new file mode 100644 index 000000000000..51c201f0659e --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/tsp-location.yaml @@ -0,0 +1,5 @@ +additionalDirectories: [] +repo: Azure/azure-rest-api-specs +commit: 70a4ccdd2be61ae5bc524250c70270b0f4f2b540 +directory: specification/programmableconnectivity/Azure.ProgrammableConnectivity + diff --git a/sdk/programmableconnectivity/ci.yml b/sdk/programmableconnectivity/ci.yml new file mode 100644 index 000000000000..deb7914f6348 --- /dev/null +++ b/sdk/programmableconnectivity/ci.yml @@ -0,0 +1,34 @@ +# DO NOT EDIT THIS FILE +# This file is generated automatically and any changes will be lost. + +trigger: + branches: + include: + - main + - hotfix/* + - release/* + - restapi* + paths: + include: + - sdk/programmableconnectivity/ + +pr: + branches: + include: + - main + - feature/* + - hotfix/* + - release/* + - restapi* + paths: + include: + - sdk/programmableconnectivity/ + +extends: + template: ../../eng/pipelines/templates/stages/archetype-sdk-client.yml + parameters: + ServiceDirectory: programmableconnectivity + TestProxy: true + Artifacts: + - name: azure-programmableconnectivity + safeName: azureprogrammableconnectivity diff --git a/sdk/purview/azure-purview-datamap/CHANGELOG.md b/sdk/purview/azure-purview-datamap/CHANGELOG.md new file mode 100644 index 000000000000..628743d283a9 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/CHANGELOG.md @@ -0,0 +1,5 @@ +# Release History + +## 1.0.0b1 (1970-01-01) + +- Initial version diff --git a/sdk/purview/azure-purview-datamap/LICENSE b/sdk/purview/azure-purview-datamap/LICENSE new file mode 100644 index 000000000000..63447fd8bbbf --- /dev/null +++ b/sdk/purview/azure-purview-datamap/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/sdk/purview/azure-purview-datamap/MANIFEST.in b/sdk/purview/azure-purview-datamap/MANIFEST.in new file mode 100644 index 000000000000..70ec06cdfc26 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/MANIFEST.in @@ -0,0 +1,7 @@ +include *.md +include LICENSE +include azure/purview/datamap/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/purview/__init__.py \ No newline at end of file diff --git a/sdk/purview/azure-purview-datamap/README.md b/sdk/purview/azure-purview-datamap/README.md new file mode 100644 index 000000000000..673de19d6e9f --- /dev/null +++ b/sdk/purview/azure-purview-datamap/README.md @@ -0,0 +1,80 @@ + + +# Azure Purview Datamap client library for Python + + +## Getting started + +### Installating the package + +```bash +python -m pip install azure-purview-datamap +``` + +#### Prequisites + +- Python 3.8 or later is required to use this package. +- You need an [Azure subscription][azure_sub] to use this package. +- An existing Azure Purview Datamap instance. +#### Create with an Azure Active Directory Credential +To use an [Azure Active Directory (AAD) token credential][authenticate_with_token], +provide an instance of the desired credential type obtained from the +[azure-identity][azure_identity_credentials] library. + +To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip] + +After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use. +As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client: + +Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: +`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET` + +Use the returned token credential to authenticate the client: + +```python +>>> from azure.purview.datamap import DataMapClient +>>> from azure.identity import DefaultAzureCredential +>>> client = DataMapClient(endpoint='', credential=DefaultAzureCredential()) +``` + +## Examples + +```python +>>> from azure.purview.datamap import DataMapClient +>>> from azure.identity import DefaultAzureCredential +>>> from azure.core.exceptions import HttpResponseError + +>>> client = DataMapClient(endpoint='', credential=DefaultAzureCredential()) +>>> try: + + except HttpResponseError as e: + print('service responds error: {}'.format(e.response.json())) + +``` + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials +[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential +[pip]: https://pypi.org/project/pip/ +[azure_sub]: https://azure.microsoft.com/free/ + diff --git a/sdk/purview/azure-purview-datamap/_meta.json b/sdk/purview/azure-purview-datamap/_meta.json new file mode 100644 index 000000000000..c3b8a96ca55a --- /dev/null +++ b/sdk/purview/azure-purview-datamap/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "70a4ccdd2be61ae5bc524250c70270b0f4f2b540", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/purview/Azure.Analytics.Purview.DataMap", + "@azure-tools/typespec-python": "0.21.0" +} \ No newline at end of file diff --git a/sdk/purview/azure-purview-datamap/azure/__init__.py b/sdk/purview/azure-purview-datamap/azure/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/purview/azure-purview-datamap/azure/purview/__init__.py b/sdk/purview/azure-purview-datamap/azure/purview/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/__init__.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/__init__.py new file mode 100644 index 000000000000..eb84dde7b903 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/__init__.py @@ -0,0 +1,26 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import DataMapClient +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DataMapClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_client.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_client.py new file mode 100644 index 000000000000..4dac6f59e70b --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_client.py @@ -0,0 +1,123 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, TYPE_CHECKING + +from azure.core import PipelineClient +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import DataMapClientConfiguration +from ._serialization import Deserializer, Serializer +from .operations import ( + DiscoveryOperations, + EntityOperations, + GlossaryOperations, + LineageOperations, + RelationshipOperations, + TypeDefinitionOperations, +) + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class DataMapClient: # pylint: disable=client-accepts-api-version-keyword + """DataMapClient. + + :ivar entity: EntityOperations operations + :vartype entity: azure.purview.datamap.operations.EntityOperations + :ivar glossary: GlossaryOperations operations + :vartype glossary: azure.purview.datamap.operations.GlossaryOperations + :ivar discovery: DiscoveryOperations operations + :vartype discovery: azure.purview.datamap.operations.DiscoveryOperations + :ivar lineage: LineageOperations operations + :vartype lineage: azure.purview.datamap.operations.LineageOperations + :ivar relationship: RelationshipOperations operations + :vartype relationship: azure.purview.datamap.operations.RelationshipOperations + :ivar type_definition: TypeDefinitionOperations operations + :vartype type_definition: azure.purview.datamap.operations.TypeDefinitionOperations + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Known values are "2023-09-01" + and None. Default value is "2023-09-01". Note that overriding this default value may result in + unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + _endpoint = "{endpoint}/datamap/api" + self._config = DataMapClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + self.entity = EntityOperations(self._client, self._config, self._serialize, self._deserialize) + self.glossary = GlossaryOperations(self._client, self._config, self._serialize, self._deserialize) + self.discovery = DiscoveryOperations(self._client, self._config, self._serialize, self._deserialize) + self.lineage = LineageOperations(self._client, self._config, self._serialize, self._deserialize) + self.relationship = RelationshipOperations(self._client, self._config, self._serialize, self._deserialize) + self.type_definition = TypeDefinitionOperations(self._client, self._config, self._serialize, self._deserialize) + + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> "DataMapClient": + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_configuration.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_configuration.py new file mode 100644 index 000000000000..1084d8ba9649 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_configuration.py @@ -0,0 +1,65 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies + +from ._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class DataMapClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for DataMapClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Known values are "2023-09-01" + and None. Default value is "2023-09-01". Note that overriding this default value may result in + unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-09-01") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://purview.azure.net/.default"]) + kwargs.setdefault("sdk_moniker", "purview-datamap/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.BearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_model_base.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_model_base.py new file mode 100644 index 000000000000..1ddc071517d6 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_model_base.py @@ -0,0 +1,874 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except + +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import copy +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] # pylint: disable=protected-access + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): # pylint: disable=unsubscriptable-object + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = copy.deepcopy(data) + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: + ... + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: + ... + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + return self._data.popitem() + + def clear(self) -> None: + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: + ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: + ... + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument + # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' + mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") # pylint: disable=no-member + for k, v in mro_class.__annotations__.items() # pylint: disable=no-member + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) + + return super().__new__(cls) # pylint: disable=no-value-for-parameter + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): # pylint: disable=no-member + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: + for v in cls.__dict__.values(): + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access + return v._rest_name # pylint: disable=protected-access + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): # pylint: disable=no-member + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member + if mapped_cls == cls: + return cls(data) + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation or annotation in [int, float]: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + except AttributeError: + pass + + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) + + try: + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + obj: typing.Dict[typing.Any, typing.Any], + ): + if obj is None: + return obj + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + return functools.partial( + _deserialize_dict, + value_deserializer, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore + + def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, + ): + if obj is None: + return obj + return type(obj)( + _deserialize(deserializer, entry, module) + for entry, deserializer in zip(obj, entry_deserializers) + ) + + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + obj, + ): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + return functools.partial(_deserialize_sequence, deserializer) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): + try: + if value is None or isinstance(value, _Null): + return None + if deserializer is None: + return value + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_patch.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_serialization.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_serialization.py new file mode 100644 index 000000000000..2f781d740827 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_serialization.py @@ -0,0 +1,1998 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the ""Software""), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + TypeVar, + MutableMapping, + Type, + List, + Mapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +ModelType = TypeVar("ModelType", bound="Model") +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + + +try: + from datetime import timezone as _FixedOffset # type: ignore +except ImportError: # Python 2.7 + + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds() / 3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node.""" + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls: Type[ModelType], + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> ModelType: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result.update(objects[valuetype]._flatten_subtype(key, objects)) + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + Remove the polymorphic key from the initial data. + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + """ + return key.replace("\\.", ".") + + +class Serializer(object): + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises: SerializationError if serialization fails. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized.update(target_obj.additional_properties) + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises: SerializationError if serialization fails. + :raises: ValueError if data is None + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + elif data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, data.__class__) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param data: Object to be serialized. + :rtype: str + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + else: + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. + :rtype: list, str + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + elif obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises: SerializationError if format invalid + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError: + raise TypeError("Unix time object must be valid Datetime object.") + + +def rest_key_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(List[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key.""" + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + else: + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + else: # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer(object): + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + elif isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None: + return data + try: + attributes = response._attribute_map # type: ignore + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + else: + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param raw_data: Data to be processed. + :param content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param response: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [k for k, v in response._validation.items() if v.get("readonly")] + const = [k for k, v in response._validation.items() if v.get("constant")] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) + + def deserialize_data(self, data, data_type): + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + else: + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :rtype: dict + :raises: TypeError if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :rtype: str, int, float or bool + :raises: TypeError if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + else: + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + elif isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + elif attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + else: + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :rtype: long or int + :raises: ValueError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :rtype: TimeDelta + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :rtype: Date + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :rtype: Datetime + :raises: DeserializationError if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + else: + return date_obj diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_version.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_version.py new file mode 100644 index 000000000000..be71c81bd282 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/__init__.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/__init__.py new file mode 100644 index 000000000000..1a94f3a4925f --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/__init__.py @@ -0,0 +1,23 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import DataMapClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DataMapClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_client.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_client.py new file mode 100644 index 000000000000..f6ff86ec1c34 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_client.py @@ -0,0 +1,125 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable, TYPE_CHECKING + +from azure.core import AsyncPipelineClient +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._serialization import Deserializer, Serializer +from ._configuration import DataMapClientConfiguration +from .operations import ( + DiscoveryOperations, + EntityOperations, + GlossaryOperations, + LineageOperations, + RelationshipOperations, + TypeDefinitionOperations, +) + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class DataMapClient: # pylint: disable=client-accepts-api-version-keyword + """DataMapClient. + + :ivar entity: EntityOperations operations + :vartype entity: azure.purview.datamap.aio.operations.EntityOperations + :ivar glossary: GlossaryOperations operations + :vartype glossary: azure.purview.datamap.aio.operations.GlossaryOperations + :ivar discovery: DiscoveryOperations operations + :vartype discovery: azure.purview.datamap.aio.operations.DiscoveryOperations + :ivar lineage: LineageOperations operations + :vartype lineage: azure.purview.datamap.aio.operations.LineageOperations + :ivar relationship: RelationshipOperations operations + :vartype relationship: azure.purview.datamap.aio.operations.RelationshipOperations + :ivar type_definition: TypeDefinitionOperations operations + :vartype type_definition: azure.purview.datamap.aio.operations.TypeDefinitionOperations + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Known values are "2023-09-01" + and None. Default value is "2023-09-01". Note that overriding this default value may result in + unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + _endpoint = "{endpoint}/datamap/api" + self._config = DataMapClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + self.entity = EntityOperations(self._client, self._config, self._serialize, self._deserialize) + self.glossary = GlossaryOperations(self._client, self._config, self._serialize, self._deserialize) + self.discovery = DiscoveryOperations(self._client, self._config, self._serialize, self._deserialize) + self.lineage = LineageOperations(self._client, self._config, self._serialize, self._deserialize) + self.relationship = RelationshipOperations(self._client, self._config, self._serialize, self._deserialize) + self.type_definition = TypeDefinitionOperations(self._client, self._config, self._serialize, self._deserialize) + + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> "DataMapClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_configuration.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_configuration.py new file mode 100644 index 000000000000..8f67d155f7df --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_configuration.py @@ -0,0 +1,65 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies + +from .._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class DataMapClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for DataMapClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Known values are "2023-09-01" + and None. Default value is "2023-09-01". Note that overriding this default value may result in + unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-09-01") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://purview.azure.net/.default"]) + kwargs.setdefault("sdk_moniker", "purview-datamap/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AsyncBearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_patch.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/operations/__init__.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/operations/__init__.py new file mode 100644 index 000000000000..f87703413c74 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/operations/__init__.py @@ -0,0 +1,29 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import EntityOperations +from ._operations import GlossaryOperations +from ._operations import DiscoveryOperations +from ._operations import LineageOperations +from ._operations import RelationshipOperations +from ._operations import TypeDefinitionOperations + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "EntityOperations", + "GlossaryOperations", + "DiscoveryOperations", + "LineageOperations", + "RelationshipOperations", + "TypeDefinitionOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/operations/_operations.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/operations/_operations.py new file mode 100644 index 000000000000..fb3edeab151f --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/operations/_operations.py @@ -0,0 +1,45106 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, List, Optional, TypeVar, Union, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._model_base import SdkJSONEncoder, _deserialize +from ...operations._operations import ( + build_discovery_auto_complete_request, + build_discovery_query_request, + build_discovery_suggest_request, + build_entity_add_classification_request, + build_entity_add_classifications_by_unique_attribute_request, + build_entity_add_classifications_request, + build_entity_add_label_request, + build_entity_add_labels_by_unique_attribute_request, + build_entity_add_or_update_business_metadata_attributes_request, + build_entity_add_or_update_business_metadata_request, + build_entity_batch_create_or_update_request, + build_entity_batch_delete_request, + build_entity_batch_get_by_unique_attributes_request, + build_entity_batch_set_classifications_request, + build_entity_create_or_update_request, + build_entity_delete_by_unique_attribute_request, + build_entity_delete_request, + build_entity_get_business_metadata_template_request, + build_entity_get_by_ids_request, + build_entity_get_by_unique_attribute_request, + build_entity_get_classification_request, + build_entity_get_classifications_request, + build_entity_get_header_request, + build_entity_get_request, + build_entity_import_business_metadata_request, + build_entity_move_entities_to_collection_request, + build_entity_remove_business_metadata_attributes_request, + build_entity_remove_business_metadata_request, + build_entity_remove_classification_by_unique_attribute_request, + build_entity_remove_classification_request, + build_entity_remove_labels_by_unique_attribute_request, + build_entity_remove_labels_request, + build_entity_set_labels_by_unique_attribute_request, + build_entity_set_labels_request, + build_entity_update_attribute_by_id_request, + build_entity_update_by_unique_attribute_request, + build_entity_update_classifications_request, + build_entity_update_classifications_unique_by_attribute_request, + build_glossary_assign_term_to_entities_request, + build_glossary_batch_get_request, + build_glossary_create_categories_request, + build_glossary_create_category_request, + build_glossary_create_request, + build_glossary_create_term_request, + build_glossary_create_terms_request, + build_glossary_delete_category_request, + build_glossary_delete_request, + build_glossary_delete_term_assignment_from_entities_request, + build_glossary_delete_term_request, + build_glossary_get_categories_headers_request, + build_glossary_get_categories_request, + build_glossary_get_category_request, + build_glossary_get_category_terms_request, + build_glossary_get_detailed_request, + build_glossary_get_entities_assigned_with_term_request, + build_glossary_get_related_categories_request, + build_glossary_get_related_terms_request, + build_glossary_get_request, + build_glossary_get_term_headers_request, + build_glossary_get_term_request, + build_glossary_get_terms_request, + build_glossary_partial_update_category_request, + build_glossary_partial_update_request, + build_glossary_partial_update_term_request, + build_glossary_update_category_request, + build_glossary_update_request, + build_glossary_update_term_request, + build_lineage_get_by_unique_attribute_request, + build_lineage_get_next_page_request, + build_lineage_get_request, + build_relationship_create_request, + build_relationship_delete_request, + build_relationship_get_request, + build_relationship_update_request, + build_type_definition_batch_create_request, + build_type_definition_batch_delete_request, + build_type_definition_batch_update_request, + build_type_definition_delete_request, + build_type_definition_get_business_metadata_by_id_request, + build_type_definition_get_business_metadata_by_name_request, + build_type_definition_get_by_id_request, + build_type_definition_get_by_name_request, + build_type_definition_get_classification_by_id_request, + build_type_definition_get_classification_by_name_request, + build_type_definition_get_entity_by_id_request, + build_type_definition_get_entity_by_name_request, + build_type_definition_get_enum_by_id_request, + build_type_definition_get_enum_by_name_request, + build_type_definition_get_headers_request, + build_type_definition_get_relationship_by_id_request, + build_type_definition_get_relationship_by_name_request, + build_type_definition_get_request, + build_type_definition_get_struct_by_id_request, + build_type_definition_get_struct_by_name_request, + build_type_definition_get_term_template_by_id_request, + build_type_definition_get_term_template_by_name_request, +) + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +_Unset: Any = object() +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class EntityOperations: # pylint: disable=too-many-public-methods + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.purview.datamap.aio.DataMapClient`'s + :attr:`entity` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + async def create_or_update( + self, + body: _models.AtlasEntityWithExtInfo, + *, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + collection_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update an entity. + Existing entity is matched using its unique guid if + supplied or by its unique attributes eg: qualifiedName. + Map and array of + collections are not well supported. E.g., array`>, array>. + For each contact type, the maximum number of contacts is 20. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasEntityWithExtInfo + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entity": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the + term assignment. + "createdBy": "str", # Optional. The user who created + the record. + "description": "str", # Optional. The description of + the term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms + assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", + "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of relationship. + }, + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the entity. + }, + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + async def create_or_update( + self, + body: JSON, + *, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + collection_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update an entity. + Existing entity is matched using its unique guid if + supplied or by its unique attributes eg: qualifiedName. + Map and array of + collections are not well supported. E.g., array`>, array>. + For each contact type, the maximum number of contacts is 20. + + :param body: Required. + :type body: JSON + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + async def create_or_update( + self, + body: IO[bytes], + *, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + collection_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update an entity. + Existing entity is matched using its unique guid if + supplied or by its unique attributes eg: qualifiedName. + Map and array of + collections are not well supported. E.g., array`>, array>. + For each contact type, the maximum number of contacts is 20. + + :param body: Required. + :type body: IO[bytes] + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @distributed_trace_async + async def create_or_update( + self, + body: Union[_models.AtlasEntityWithExtInfo, JSON, IO[bytes]], + *, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + collection_id: Optional[str] = None, + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update an entity. + Existing entity is matched using its unique guid if + supplied or by its unique attributes eg: qualifiedName. + Map and array of + collections are not well supported. E.g., array`>, array>. + For each contact type, the maximum number of contacts is 20. + + :param body: Is one of the following types: AtlasEntityWithExtInfo, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasEntityWithExtInfo or JSON or IO[bytes] + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entity": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the + term assignment. + "createdBy": "str", # Optional. The user who created + the record. + "description": "str", # Optional. The description of + the term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms + assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", + "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of relationship. + }, + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the entity. + }, + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_create_or_update_request( + business_attribute_update_behavior=business_attribute_update_behavior, + collection_id=collection_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_by_ids( + self, + *, + guid: List[str], + min_ext_info: Optional[bool] = None, + ignore_relationships: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasEntitiesWithExtInfo: + # pylint: disable=line-too-long + """List entities in bulk identified by its GUIDs. + + :keyword guid: An array of GUIDs of entities to list. Required. + :paramtype guid: list[str] + :keyword min_ext_info: Whether to return minimal information for referred entities. Default + value is None. + :paramtype min_ext_info: bool + :keyword ignore_relationships: Whether to ignore relationship attributes. Default value is + None. + :paramtype ignore_relationships: bool + :return: AtlasEntitiesWithExtInfo. The AtlasEntitiesWithExtInfo is compatible with + MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntitiesWithExtInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "entities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + ], + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntitiesWithExtInfo] = kwargs.pop("cls", None) + + _request = build_entity_get_by_ids_request( + guid=guid, + min_ext_info=min_ext_info, + ignore_relationships=ignore_relationships, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntitiesWithExtInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def batch_create_or_update( + self, + body: _models.AtlasEntitiesWithExtInfo, + *, + collection_id: Optional[str] = None, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update entities in bulk. + Existing entity is matched using its unique + guid if supplied or by its unique attributes eg: qualifiedName. + Map and array + of collections are not well supported. E.g., array`>, + array>. + For each contact type, the maximum number of contacts + is 20. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasEntitiesWithExtInfo + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + ], + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + async def batch_create_or_update( + self, + body: JSON, + *, + collection_id: Optional[str] = None, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update entities in bulk. + Existing entity is matched using its unique + guid if supplied or by its unique attributes eg: qualifiedName. + Map and array + of collections are not well supported. E.g., array`>, + array>. + For each contact type, the maximum number of contacts + is 20. + + :param body: Required. + :type body: JSON + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + async def batch_create_or_update( + self, + body: IO[bytes], + *, + collection_id: Optional[str] = None, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update entities in bulk. + Existing entity is matched using its unique + guid if supplied or by its unique attributes eg: qualifiedName. + Map and array + of collections are not well supported. E.g., array`>, + array>. + For each contact type, the maximum number of contacts + is 20. + + :param body: Required. + :type body: IO[bytes] + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @distributed_trace_async + async def batch_create_or_update( + self, + body: Union[_models.AtlasEntitiesWithExtInfo, JSON, IO[bytes]], + *, + collection_id: Optional[str] = None, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update entities in bulk. + Existing entity is matched using its unique + guid if supplied or by its unique attributes eg: qualifiedName. + Map and array + of collections are not well supported. E.g., array`>, + array>. + For each contact type, the maximum number of contacts + is 20. + + :param body: Is one of the following types: AtlasEntitiesWithExtInfo, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasEntitiesWithExtInfo or JSON or IO[bytes] + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + ], + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_batch_create_or_update_request( + collection_id=collection_id, + business_attribute_update_behavior=business_attribute_update_behavior, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def batch_delete(self, *, guid: List[str], **kwargs: Any) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Delete a list of entities in bulk identified by their GUIDs or unique + attributes. + + :keyword guid: An array of GUIDs of entities to delete. Required. + :paramtype guid: list[str] + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + _request = build_entity_batch_delete_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def add_classification( # pylint: disable=inconsistent-return-statements + self, body: _models.ClassificationAssociateOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Associate a classification to multiple entities in bulk. + + :param body: Required. + :type body: ~azure.purview.datamap.models.ClassificationAssociateOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "classification": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time + boundary. + "startTime": "str", # Optional. The start of the + time boundary. + "timeZone": "str" # Optional. The timezone of the + time boundary. + } + ] + }, + "entityGuids": [ + "str" # Optional. The GUID of the entity. + ] + } + """ + + @overload + async def add_classification( # pylint: disable=inconsistent-return-statements + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Associate a classification to multiple entities in bulk. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def add_classification( # pylint: disable=inconsistent-return-statements + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Associate a classification to multiple entities in bulk. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def add_classification( # pylint: disable=inconsistent-return-statements + self, body: Union[_models.ClassificationAssociateOptions, JSON, IO[bytes]], **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Associate a classification to multiple entities in bulk. + + :param body: Is one of the following types: ClassificationAssociateOptions, JSON, IO[bytes] + Required. + :type body: ~azure.purview.datamap.models.ClassificationAssociateOptions or JSON or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "classification": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time + boundary. + "startTime": "str", # Optional. The start of the + time boundary. + "timeZone": "str" # Optional. The timezone of the + time boundary. + } + ] + }, + "entityGuids": [ + "str" # Optional. The GUID of the entity. + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_add_classification_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def get( + self, + guid: str, + *, + min_ext_info: Optional[bool] = None, + ignore_relationships: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasEntityWithExtInfo: + # pylint: disable=line-too-long + """Get complete definition of an entity given its GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :keyword min_ext_info: Whether to return minimal information for referred entities. Default + value is None. + :paramtype min_ext_info: bool + :keyword ignore_relationships: Whether to ignore relationship attributes. Default value is + None. + :paramtype ignore_relationships: bool + :return: AtlasEntityWithExtInfo. The AtlasEntityWithExtInfo is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntityWithExtInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "entity": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the + term assignment. + "createdBy": "str", # Optional. The user who created + the record. + "description": "str", # Optional. The description of + the term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms + assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", + "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of relationship. + }, + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the entity. + }, + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntityWithExtInfo] = kwargs.pop("cls", None) + + _request = build_entity_get_request( + guid=guid, + min_ext_info=min_ext_info, + ignore_relationships=ignore_relationships, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntityWithExtInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def update_attribute_by_id( + self, guid: str, body: Any, *, name: str, **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Update entity partially - create or update entity attribute identified by its + GUID. + Supports only primitive attribute type and entity references. + It does not support updating complex types like arrays, and maps. + Null updates are not possible. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: The value of the attribute. Required. + :type body: any + :keyword name: The name of the attribute. Required. + :paramtype name: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: str = kwargs.pop("content_type", _headers.pop("Content-Type", "application/json")) + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_update_attribute_by_id_request( + guid=guid, + name=name, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete(self, guid: str, **kwargs: Any) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Delete an entity identified by its GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + _request = build_entity_delete_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_classification( + self, guid: str, classification_name: str, **kwargs: Any + ) -> _models.AtlasClassification: + # pylint: disable=line-too-long + """Get classification for a given entity represented by a GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param classification_name: The name of the classification. Required. + :type classification_name: str + :return: AtlasClassification. The AtlasClassification is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasClassification + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time boundary. + "startTime": "str", # Optional. The start of the time + boundary. + "timeZone": "str" # Optional. The timezone of the time + boundary. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasClassification] = kwargs.pop("cls", None) + + _request = build_entity_get_classification_request( + guid=guid, + classification_name=classification_name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasClassification, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def remove_classification( # pylint: disable=inconsistent-return-statements + self, guid: str, classification_name: str, **kwargs: Any + ) -> None: + """Delete a given classification from an existing entity represented by a GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param classification_name: The name of the classification. Required. + :type classification_name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_entity_remove_classification_request( + guid=guid, + classification_name=classification_name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def get_classifications(self, guid: str, **kwargs: Any) -> _models.AtlasClassifications: + # pylint: disable=line-too-long + """List classifications for a given entity represented by a GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :return: AtlasClassifications. The AtlasClassifications is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasClassifications + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "list": [ + {} # Optional. An array of objects. + ], + "pageSize": 0, # Optional. The size of the page. + "sortBy": "str", # Optional. The sorted by field. + "sortType": "str", # Optional. to specify whether the result should be + sorted? If yes, whether asc or desc. Known values are: "NONE", "ASC", and "DESC". + "startIndex": 0, # Optional. The start index of the page. + "totalCount": 0 # Optional. The total count of items. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasClassifications] = kwargs.pop("cls", None) + + _request = build_entity_get_classifications_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasClassifications, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def add_classifications( # pylint: disable=inconsistent-return-statements + self, + guid: str, + body: List[_models.AtlasClassification], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Add classifications to an existing entity represented by a GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: An array of classifications to be added. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time + boundary. + "startTime": "str", # Optional. The start of the + time boundary. + "timeZone": "str" # Optional. The timezone of the + time boundary. + } + ] + } + ] + """ + + @overload + async def add_classifications( # pylint: disable=inconsistent-return-statements + self, guid: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Add classifications to an existing entity represented by a GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: An array of classifications to be added. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def add_classifications( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Union[List[_models.AtlasClassification], IO[bytes]], **kwargs: Any + ) -> None: + """Add classifications to an existing entity represented by a GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: An array of classifications to be added. Is either a [AtlasClassification] type or + a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_add_classifications_request( + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def update_classifications( # pylint: disable=inconsistent-return-statements + self, + guid: str, + body: List[_models.AtlasClassification], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Update classifications to an existing entity represented by a guid. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: An array of classifications to be updated. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time + boundary. + "startTime": "str", # Optional. The start of the + time boundary. + "timeZone": "str" # Optional. The timezone of the + time boundary. + } + ] + } + ] + """ + + @overload + async def update_classifications( # pylint: disable=inconsistent-return-statements + self, guid: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Update classifications to an existing entity represented by a guid. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: An array of classifications to be updated. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def update_classifications( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Union[List[_models.AtlasClassification], IO[bytes]], **kwargs: Any + ) -> None: + """Update classifications to an existing entity represented by a guid. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: An array of classifications to be updated. Is either a [AtlasClassification] type + or a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_update_classifications_request( + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def get_by_unique_attribute( + self, + type_name: str, + *, + min_ext_info: Optional[bool] = None, + ignore_relationships: Optional[bool] = None, + attribute: Optional[str] = None, + **kwargs: Any + ) -> _models.AtlasEntityWithExtInfo: + # pylint: disable=line-too-long + """Get complete definition of an entity given its type and unique attribute. + + In + addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the following format: + attr:\:code:``=:code:``. + + NOTE: The + attrName and attrValue should be unique across entities, eg. + qualifiedName. + + The REST request would look something like this: + GET + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :keyword min_ext_info: Whether to return minimal information for referred entities. Default + value is None. + :paramtype min_ext_info: bool + :keyword ignore_relationships: Whether to ignore relationship attributes. Default value is + None. + :paramtype ignore_relationships: bool + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: AtlasEntityWithExtInfo. The AtlasEntityWithExtInfo is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntityWithExtInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "entity": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the + term assignment. + "createdBy": "str", # Optional. The user who created + the record. + "description": "str", # Optional. The description of + the term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms + assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", + "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of relationship. + }, + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the entity. + }, + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntityWithExtInfo] = kwargs.pop("cls", None) + + _request = build_entity_get_by_unique_attribute_request( + type_name=type_name, + min_ext_info=min_ext_info, + ignore_relationships=ignore_relationships, + attribute=attribute, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntityWithExtInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def update_by_unique_attribute( + self, + type_name: str, + body: _models.AtlasEntityWithExtInfo, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Update entity partially - Allow a subset of attributes to be updated on an + entity which is identified by its type and unique attribute eg: + Referenceable.qualifiedName. Null updates are not possible. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: + + attr::code:``=:code:``. + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: + PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasEntityWithExtInfo + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entity": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the + term assignment. + "createdBy": "str", # Optional. The user who created + the record. + "description": "str", # Optional. The description of + the term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms + assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", + "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of relationship. + }, + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the entity. + }, + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + async def update_by_unique_attribute( + self, + type_name: str, + body: JSON, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Update entity partially - Allow a subset of attributes to be updated on an + entity which is identified by its type and unique attribute eg: + Referenceable.qualifiedName. Null updates are not possible. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: + + attr::code:``=:code:``. + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: + PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: Required. + :type body: JSON + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + async def update_by_unique_attribute( + self, + type_name: str, + body: IO[bytes], + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Update entity partially - Allow a subset of attributes to be updated on an + entity which is identified by its type and unique attribute eg: + Referenceable.qualifiedName. Null updates are not possible. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: + + attr::code:``=:code:``. + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: + PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: Required. + :type body: IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @distributed_trace_async + async def update_by_unique_attribute( + self, + type_name: str, + body: Union[_models.AtlasEntityWithExtInfo, JSON, IO[bytes]], + *, + attribute: Optional[str] = None, + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Update entity partially - Allow a subset of attributes to be updated on an + entity which is identified by its type and unique attribute eg: + Referenceable.qualifiedName. Null updates are not possible. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: + + attr::code:``=:code:``. + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: + PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: Is one of the following types: AtlasEntityWithExtInfo, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasEntityWithExtInfo or JSON or IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entity": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the + term assignment. + "createdBy": "str", # Optional. The user who created + the record. + "description": "str", # Optional. The description of + the term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms + assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", + "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of relationship. + }, + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the entity. + }, + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_update_by_unique_attribute_request( + type_name=type_name, + attribute=attribute, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete_by_unique_attribute( + self, type_name: str, *, attribute: Optional[str] = None, **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Delete an entity identified by its type and unique attributes. + In addition to + the typeName path parameter, attribute key-value pair(s) can be provided in the + following format: + attr:\:code:``=\:code:``. + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: + DELETE + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + _request = build_entity_delete_by_unique_attribute_request( + type_name=type_name, + attribute=attribute, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def remove_classification_by_unique_attribute( # pylint: disable=inconsistent-return-statements,name-too-long + self, type_name: str, classification_name: str, *, attribute: Optional[str] = None, **kwargs: Any + ) -> None: + """Delete a given classification from an entity identified by its type and unique + attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param classification_name: The name of the classification. Required. + :type classification_name: str + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_entity_remove_classification_by_unique_attribute_request( + type_name=type_name, + classification_name=classification_name, + attribute=attribute, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def add_classifications_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: List[_models.AtlasClassification], + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Add classification to the entity identified by its type and unique attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: An array of classification to be added. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time + boundary. + "startTime": "str", # Optional. The start of the + time boundary. + "timeZone": "str" # Optional. The timezone of the + time boundary. + } + ] + } + ] + """ + + @overload + async def add_classifications_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: IO[bytes], + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add classification to the entity identified by its type and unique attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: An array of classification to be added. Required. + :type body: IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def add_classifications_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Union[List[_models.AtlasClassification], IO[bytes]], + *, + attribute: Optional[str] = None, + **kwargs: Any + ) -> None: + """Add classification to the entity identified by its type and unique attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: An array of classification to be added. Is either a [AtlasClassification] type or + a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] or IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_add_classifications_by_unique_attribute_request( + type_name=type_name, + attribute=attribute, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def update_classifications_unique_by_attribute( # pylint: disable=inconsistent-return-statements,name-too-long + self, + type_name: str, + body: List[_models.AtlasClassification], + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Update classification on an entity identified by its type and unique attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: An array of classification to be updated. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time + boundary. + "startTime": "str", # Optional. The start of the + time boundary. + "timeZone": "str" # Optional. The timezone of the + time boundary. + } + ] + } + ] + """ + + @overload + async def update_classifications_unique_by_attribute( # pylint: disable=inconsistent-return-statements,name-too-long + self, + type_name: str, + body: IO[bytes], + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Update classification on an entity identified by its type and unique attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: An array of classification to be updated. Required. + :type body: IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def update_classifications_unique_by_attribute( # pylint: disable=inconsistent-return-statements,name-too-long + self, + type_name: str, + body: Union[List[_models.AtlasClassification], IO[bytes]], + *, + attribute: Optional[str] = None, + **kwargs: Any + ) -> None: + """Update classification on an entity identified by its type and unique attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: An array of classification to be updated. Is either a [AtlasClassification] type + or a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] or IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_update_classifications_unique_by_attribute_request( + type_name=type_name, + attribute=attribute, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def batch_set_classifications( + self, body: _models.AtlasEntityHeaders, *, content_type: str = "application/json", **kwargs: Any + ) -> List[str]: + # pylint: disable=line-too-long + """Set classifications on entities in bulk. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasEntityHeaders + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: list of str + :rtype: list[str] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "guidHeaderMap": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + } + } + + # response body for status code(s): 200 + response == [ + "str" # Optional. + ] + """ + + @overload + async def batch_set_classifications( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> List[str]: + """Set classifications on entities in bulk. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: list of str + :rtype: list[str] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + "str" # Optional. + ] + """ + + @overload + async def batch_set_classifications( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> List[str]: + """Set classifications on entities in bulk. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: list of str + :rtype: list[str] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + "str" # Optional. + ] + """ + + @distributed_trace_async + async def batch_set_classifications( + self, body: Union[_models.AtlasEntityHeaders, JSON, IO[bytes]], **kwargs: Any + ) -> List[str]: + # pylint: disable=line-too-long + """Set classifications on entities in bulk. + + :param body: Is one of the following types: AtlasEntityHeaders, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasEntityHeaders or JSON or IO[bytes] + :return: list of str + :rtype: list[str] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "guidHeaderMap": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + } + } + + # response body for status code(s): 200 + response == [ + "str" # Optional. + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[List[str]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_batch_set_classifications_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[str], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def batch_get_by_unique_attributes( + self, + type_name: str, + *, + min_ext_info: Optional[bool] = None, + ignore_relationships: Optional[bool] = None, + attr_n_qualified_name: Optional[str] = None, + **kwargs: Any + ) -> _models.AtlasEntitiesWithExtInfo: + # pylint: disable=line-too-long + """Bulk API to retrieve list of entities identified by its unique attributes. + In + addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the following + format + + typeName=\:code:``&attr_1:\:code:``=\:code:``&attr_2:\:code:``=\:code:``&attr_3:\:code:``=\:code:`` + + NOTE: + The attrName should be an unique attribute for the given entity-type. + The REST + request would look something like this + + GET + /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 + + Note: + at least one unique attribute must be provided. + + :param type_name: The name of the type. Required. + :type type_name: str + :keyword min_ext_info: Whether to return minimal information for referred entities. Default + value is None. + :paramtype min_ext_info: bool + :keyword ignore_relationships: Whether to ignore relationship attributes. Default value is + None. + :paramtype ignore_relationships: bool + :keyword attr_n_qualified_name: Qualified name of an entity. E.g. to find 2 entities you can + set + attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an + example. qualifiedName can be changed to other unique attributes). Default value is None. + :paramtype attr_n_qualified_name: str + :return: AtlasEntitiesWithExtInfo. The AtlasEntitiesWithExtInfo is compatible with + MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntitiesWithExtInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "entities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + ], + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntitiesWithExtInfo] = kwargs.pop("cls", None) + + _request = build_entity_batch_get_by_unique_attributes_request( + type_name=type_name, + min_ext_info=min_ext_info, + ignore_relationships=ignore_relationships, + attr_n_qualified_name=attr_n_qualified_name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntitiesWithExtInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_header(self, guid: str, **kwargs: Any) -> _models.AtlasEntityHeader: + # pylint: disable=line-too-long + """Get entity header given its GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :return: AtlasEntityHeader. The AtlasEntityHeader is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntityHeader + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the term + assignment. + "createdBy": "str", # Optional. The user who created the + record. + "description": "str", # Optional. The description of the + term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term + assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms assignment. + Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", "VALIDATED", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str" # Optional. The name of the type. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntityHeader] = kwargs.pop("cls", None) + + _request = build_entity_get_header_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntityHeader, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def remove_business_metadata( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Dict[str, Dict[str, Any]], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Remove business metadata from an entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata payload. Required. + :type body: dict[str, dict[str, any]] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": { + "str": {} # Optional. + } + } + """ + + @overload + async def remove_business_metadata( # pylint: disable=inconsistent-return-statements + self, guid: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Remove business metadata from an entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata payload. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def remove_business_metadata( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Union[Dict[str, Dict[str, Any]], IO[bytes]], **kwargs: Any + ) -> None: + """Remove business metadata from an entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata payload. Is either a {str: {str: Any}} type or a IO[bytes] type. + Required. + :type body: dict[str, dict[str, any]] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_remove_business_metadata_request( + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def add_or_update_business_metadata( # pylint: disable=inconsistent-return-statements + self, + guid: str, + body: Dict[str, Dict[str, Any]], + *, + overwrite: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add business metadata to an entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: BusinessMetadata payload. Required. + :type body: dict[str, dict[str, any]] + :keyword overwrite: Whether to overwrite the existing business metadata on the entity or not, + default is false. Default value is None. + :paramtype overwrite: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": { + "str": {} # Optional. + } + } + """ + + @overload + async def add_or_update_business_metadata( # pylint: disable=inconsistent-return-statements + self, + guid: str, + body: IO[bytes], + *, + overwrite: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add business metadata to an entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: BusinessMetadata payload. Required. + :type body: IO[bytes] + :keyword overwrite: Whether to overwrite the existing business metadata on the entity or not, + default is false. Default value is None. + :paramtype overwrite: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def add_or_update_business_metadata( # pylint: disable=inconsistent-return-statements + self, + guid: str, + body: Union[Dict[str, Dict[str, Any]], IO[bytes]], + *, + overwrite: Optional[bool] = None, + **kwargs: Any + ) -> None: + """Add business metadata to an entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: BusinessMetadata payload. Is either a {str: {str: Any}} type or a IO[bytes] type. + Required. + :type body: dict[str, dict[str, any]] or IO[bytes] + :keyword overwrite: Whether to overwrite the existing business metadata on the entity or not, + default is false. Default value is None. + :paramtype overwrite: bool + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_add_or_update_business_metadata_request( + guid=guid, + overwrite=overwrite, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def remove_business_metadata_attributes( # pylint: disable=inconsistent-return-statements + self, + business_metadata_name: str, + guid: str, + body: Dict[str, Any], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Delete business metadata attributes from an entity. + + :param business_metadata_name: BusinessMetadata name. Required. + :type business_metadata_name: str + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata attribute payload. Required. + :type body: dict[str, any] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": {} # Optional. + } + """ + + @overload + async def remove_business_metadata_attributes( # pylint: disable=inconsistent-return-statements + self, + business_metadata_name: str, + guid: str, + body: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Delete business metadata attributes from an entity. + + :param business_metadata_name: BusinessMetadata name. Required. + :type business_metadata_name: str + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata attribute payload. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def remove_business_metadata_attributes( # pylint: disable=inconsistent-return-statements + self, business_metadata_name: str, guid: str, body: Union[Dict[str, Any], IO[bytes]], **kwargs: Any + ) -> None: + """Delete business metadata attributes from an entity. + + :param business_metadata_name: BusinessMetadata name. Required. + :type business_metadata_name: str + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata attribute payload. Is either a {str: Any} type or a IO[bytes] + type. Required. + :type body: dict[str, any] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_remove_business_metadata_attributes_request( + business_metadata_name=business_metadata_name, + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def add_or_update_business_metadata_attributes( # pylint: disable=inconsistent-return-statements,name-too-long + self, + business_metadata_name: str, + guid: str, + body: Dict[str, Any], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add or update business metadata attributes. + + :param business_metadata_name: BusinessMetadata name. Required. + :type business_metadata_name: str + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata attribute payload. Required. + :type body: dict[str, any] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": {} # Optional. + } + """ + + @overload + async def add_or_update_business_metadata_attributes( # pylint: disable=inconsistent-return-statements,name-too-long + self, + business_metadata_name: str, + guid: str, + body: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add or update business metadata attributes. + + :param business_metadata_name: BusinessMetadata name. Required. + :type business_metadata_name: str + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata attribute payload. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def add_or_update_business_metadata_attributes( # pylint: disable=inconsistent-return-statements,name-too-long + self, business_metadata_name: str, guid: str, body: Union[Dict[str, Any], IO[bytes]], **kwargs: Any + ) -> None: + """Add or update business metadata attributes. + + :param business_metadata_name: BusinessMetadata name. Required. + :type business_metadata_name: str + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata attribute payload. Is either a {str: Any} type or a IO[bytes] + type. Required. + :type body: dict[str, any] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_add_or_update_business_metadata_attributes_request( + business_metadata_name=business_metadata_name, + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def get_business_metadata_template(self, **kwargs: Any) -> bytes: + """Get the sample Template for uploading/creating bulk BusinessMetaData. + + :return: bytes + :rtype: bytes + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[bytes] = kwargs.pop("cls", None) + + _request = build_entity_get_business_metadata_template_request( + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", True) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + await response.read() + deserialized = response.content + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def import_business_metadata(self, body: JSON, **kwargs: Any) -> _models.BulkImportResult: + """Upload the file for creating Business Metadata in BULK. + + :param body: Required. + :type body: JSON + :return: BulkImportResult. The BulkImportResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.BulkImportResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "file": bytes("bytes", encoding="utf-8") # InputStream of file. Required. + } + + # response body for status code(s): 200 + response == { + "failedImportInfoList": [ + { + "childObjectName": "str", # Optional. childObjectName. + "importStatus": "str", # Optional. importStatus. Known + values are: "SUCCESS" and "FAILED". + "parentObjectName": "str", # Optional. parentObjectName. + "remarks": "str" # Optional. remarks. + } + ], + "successImportInfoList": [ + { + "childObjectName": "str", # Optional. childObjectName. + "importStatus": "str", # Optional. importStatus. Known + values are: "SUCCESS" and "FAILED". + "parentObjectName": "str", # Optional. parentObjectName. + "remarks": "str" # Optional. remarks. + } + ] + } + """ + + @overload + async def import_business_metadata(self, *, file: bytes, **kwargs: Any) -> _models.BulkImportResult: + """Upload the file for creating Business Metadata in BULK. + + :keyword file: InputStream of file. Required. + :paramtype file: bytes + :return: BulkImportResult. The BulkImportResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.BulkImportResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "failedImportInfoList": [ + { + "childObjectName": "str", # Optional. childObjectName. + "importStatus": "str", # Optional. importStatus. Known + values are: "SUCCESS" and "FAILED". + "parentObjectName": "str", # Optional. parentObjectName. + "remarks": "str" # Optional. remarks. + } + ], + "successImportInfoList": [ + { + "childObjectName": "str", # Optional. childObjectName. + "importStatus": "str", # Optional. importStatus. Known + values are: "SUCCESS" and "FAILED". + "parentObjectName": "str", # Optional. parentObjectName. + "remarks": "str" # Optional. remarks. + } + ] + } + """ + + @distributed_trace_async + async def import_business_metadata( + self, body: JSON = _Unset, *, file: bytes = _Unset, **kwargs: Any + ) -> _models.BulkImportResult: + """Upload the file for creating Business Metadata in BULK. + + :param body: Is one of the following types: JSON Required. + :type body: JSON + :keyword file: InputStream of file. Required. + :paramtype file: bytes + :return: BulkImportResult. The BulkImportResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.BulkImportResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "file": bytes("bytes", encoding="utf-8") # InputStream of file. Required. + } + + # response body for status code(s): 200 + response == { + "failedImportInfoList": [ + { + "childObjectName": "str", # Optional. childObjectName. + "importStatus": "str", # Optional. importStatus. Known + values are: "SUCCESS" and "FAILED". + "parentObjectName": "str", # Optional. parentObjectName. + "remarks": "str" # Optional. remarks. + } + ], + "successImportInfoList": [ + { + "childObjectName": "str", # Optional. childObjectName. + "importStatus": "str", # Optional. importStatus. Known + values are: "SUCCESS" and "FAILED". + "parentObjectName": "str", # Optional. parentObjectName. + "remarks": "str" # Optional. remarks. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.BulkImportResult] = kwargs.pop("cls", None) + + if body is _Unset: + if file is _Unset: + raise TypeError("missing required argument: file") + body = {"file": file} + body = {k: v for k, v in body.items() if v is not None} + content_type = content_type or "multipart/form-data" + _content = None + if isinstance(body, MutableMapping): + _content = body + elif isinstance(body, MutableMapping): + _content = body + + _request = build_entity_import_business_metadata_request( + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.BulkImportResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def remove_labels( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[List[str]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Delete given labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be deleted. Default value is None. + :type body: list[str] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + "str" # Optional. + ] + """ + + @overload + async def remove_labels( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Delete given labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be deleted. Default value is None. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def remove_labels( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[Union[List[str], IO[bytes]]] = None, **kwargs: Any + ) -> None: + """Delete given labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be deleted. Is either a [str] type or a IO[bytes] type. Default + value is None. + :type body: list[str] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + _request = build_entity_remove_labels_request( + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def set_labels( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[List[str]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Set labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be set to the entity. Default value is None. + :type body: list[str] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + "str" # Optional. + ] + """ + + @overload + async def set_labels( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Set labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be set to the entity. Default value is None. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def set_labels( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[Union[List[str], IO[bytes]]] = None, **kwargs: Any + ) -> None: + """Set labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be set to the entity. Is either a [str] type or a IO[bytes] type. + Default value is None. + :type body: list[str] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + _request = build_entity_set_labels_request( + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def add_label( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[List[str]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Add given labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be added. Default value is None. + :type body: list[str] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + "str" # Optional. + ] + """ + + @overload + async def add_label( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Add given labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be added. Default value is None. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def add_label( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[Union[List[str], IO[bytes]]] = None, **kwargs: Any + ) -> None: + """Add given labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be added. Is either a [str] type or a IO[bytes] type. Default + value is None. + :type body: list[str] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + _request = build_entity_add_label_request( + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[List[str]] = None, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Delete given labels to a given entity identified by its type and unique + attribute. + + If labels is null/empty, no labels will be removed. + + If any labels + in labels set are non-existing labels, they will be ignored, only existing + labels will be removed. In addition to the typeName path parameter, attribute + key-value pair(s) can be provided in the following format: + attr::code:``=:code:``. NOTE: The attrName and attrValue should be unique + across entities, eg. qualifiedName. The REST request would look something like + this: DELETE + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be deleted. Default value is None. + :type body: list[str] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + "str" # Optional. + ] + """ + + @overload + async def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[IO[bytes]] = None, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Delete given labels to a given entity identified by its type and unique + attribute. + + If labels is null/empty, no labels will be removed. + + If any labels + in labels set are non-existing labels, they will be ignored, only existing + labels will be removed. In addition to the typeName path parameter, attribute + key-value pair(s) can be provided in the following format: + attr::code:``=:code:``. NOTE: The attrName and attrValue should be unique + across entities, eg. qualifiedName. The REST request would look something like + this: DELETE + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be deleted. Default value is None. + :type body: IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[Union[List[str], IO[bytes]]] = None, + *, + attribute: Optional[str] = None, + **kwargs: Any + ) -> None: + """Delete given labels to a given entity identified by its type and unique + attribute. + + If labels is null/empty, no labels will be removed. + + If any labels + in labels set are non-existing labels, they will be ignored, only existing + labels will be removed. In addition to the typeName path parameter, attribute + key-value pair(s) can be provided in the following format: + attr::code:``=:code:``. NOTE: The attrName and attrValue should be unique + across entities, eg. qualifiedName. The REST request would look something like + this: DELETE + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be deleted. Is either a [str] type or a IO[bytes] type. Default + value is None. + :type body: list[str] or IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + _request = build_entity_remove_labels_by_unique_attribute_request( + type_name=type_name, + attribute=attribute, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[List[str]] = None, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Set labels to a given entity identified by its type and unique attributes. + + If + labels is null/empty, existing labels will all be removed. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr::code:``=:code:``. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: POST + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be set. Default value is None. + :type body: list[str] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + "str" # Optional. + ] + """ + + @overload + async def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[IO[bytes]] = None, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Set labels to a given entity identified by its type and unique attributes. + + If + labels is null/empty, existing labels will all be removed. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr::code:``=:code:``. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: POST + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be set. Default value is None. + :type body: IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[Union[List[str], IO[bytes]]] = None, + *, + attribute: Optional[str] = None, + **kwargs: Any + ) -> None: + """Set labels to a given entity identified by its type and unique attributes. + + If + labels is null/empty, existing labels will all be removed. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr::code:``=:code:``. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: POST + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be set. Is either a [str] type or a IO[bytes] type. Default value + is None. + :type body: list[str] or IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + _request = build_entity_set_labels_by_unique_attribute_request( + type_name=type_name, + attribute=attribute, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[List[str]] = None, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add given labels to a given entity identified by its type and unique + attributes. + + If labels is null/empty, no labels will be added. + + In addition to + the typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr::code:``=:code:``. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be added. Default value is None. + :type body: list[str] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + "str" # Optional. + ] + """ + + @overload + async def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[IO[bytes]] = None, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add given labels to a given entity identified by its type and unique + attributes. + + If labels is null/empty, no labels will be added. + + In addition to + the typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr::code:``=:code:``. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be added. Default value is None. + :type body: IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[Union[List[str], IO[bytes]]] = None, + *, + attribute: Optional[str] = None, + **kwargs: Any + ) -> None: + """Add given labels to a given entity identified by its type and unique + attributes. + + If labels is null/empty, no labels will be added. + + In addition to + the typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr::code:``=:code:``. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be added. Is either a [str] type or a IO[bytes] type. Default + value is None. + :type body: list[str] or IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + _request = build_entity_add_labels_by_unique_attribute_request( + type_name=type_name, + attribute=attribute, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def move_entities_to_collection( + self, + body: _models.MoveEntitiesOptions, + *, + collection_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Move existing entities to the target collection. + + :param body: Required. + :type body: ~azure.purview.datamap.models.MoveEntitiesOptions + :keyword collection_id: The collection where entities will be moved to. Required. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entityGuids": [ + "str" # Optional. An array of entity guids to be moved to target + collection. + ] + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + async def move_entities_to_collection( + self, body: JSON, *, collection_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Move existing entities to the target collection. + + :param body: Required. + :type body: JSON + :keyword collection_id: The collection where entities will be moved to. Required. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + async def move_entities_to_collection( + self, body: IO[bytes], *, collection_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Move existing entities to the target collection. + + :param body: Required. + :type body: IO[bytes] + :keyword collection_id: The collection where entities will be moved to. Required. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @distributed_trace_async + async def move_entities_to_collection( + self, body: Union[_models.MoveEntitiesOptions, JSON, IO[bytes]], *, collection_id: str, **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Move existing entities to the target collection. + + :param body: Is one of the following types: MoveEntitiesOptions, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.MoveEntitiesOptions or JSON or IO[bytes] + :keyword collection_id: The collection where entities will be moved to. Required. + :paramtype collection_id: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entityGuids": [ + "str" # Optional. An array of entity guids to be moved to target + collection. + ] + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_move_entities_to_collection_request( + collection_id=collection_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + +class GlossaryOperations: # pylint: disable=too-many-public-methods + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.purview.datamap.aio.DataMapClient`'s + :attr:`glossary` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace_async + async def batch_get( + self, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + ignore_terms_and_categories: Optional[bool] = None, + **kwargs: Any + ) -> List[_models.AtlasGlossary]: + # pylint: disable=line-too-long + """Get all glossaries. Recommend using limit/offset to get pagination result. + Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories + separately using + + 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' + and + + 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'. + + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :return: list of AtlasGlossary + :rtype: list[~azure.purview.datamap.models.AtlasGlossary] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasGlossary]] = kwargs.pop("cls", None) + + _request = build_glossary_batch_get_request( + limit=limit, + offset=offset, + sort=sort, + ignore_terms_and_categories=ignore_terms_and_categories, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasGlossary], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create( + self, body: _models.AtlasGlossary, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Create a glossary. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasGlossary + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @overload + async def create( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Create a glossary. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @overload + async def create( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Create a glossary. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @distributed_trace_async + async def create(self, body: Union[_models.AtlasGlossary, JSON, IO[bytes]], **kwargs: Any) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Create a glossary. + + :param body: Is one of the following types: AtlasGlossary, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasGlossary or JSON or IO[bytes] + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossary] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_create_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossary, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_categories( + self, body: List[_models.AtlasGlossaryCategory], *, content_type: str = "application/json", **kwargs: Any + ) -> List[_models.AtlasGlossaryCategory]: + # pylint: disable=line-too-long + """Create glossary category in bulk. + + :param body: An array of glossary category definitions to be created. Required. + :type body: list[~azure.purview.datamap.models.AtlasGlossaryCategory] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: list of AtlasGlossaryCategory + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryCategory] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + ] + + # response body for status code(s): 200 + response == [ + { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + ] + """ + + @overload + async def create_categories( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> List[_models.AtlasGlossaryCategory]: + # pylint: disable=line-too-long + """Create glossary category in bulk. + + :param body: An array of glossary category definitions to be created. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: list of AtlasGlossaryCategory + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryCategory] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + ] + """ + + @distributed_trace_async + async def create_categories( + self, body: Union[List[_models.AtlasGlossaryCategory], IO[bytes]], **kwargs: Any + ) -> List[_models.AtlasGlossaryCategory]: + # pylint: disable=line-too-long + """Create glossary category in bulk. + + :param body: An array of glossary category definitions to be created. Is either a + [AtlasGlossaryCategory] type or a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasGlossaryCategory] or IO[bytes] + :return: list of AtlasGlossaryCategory + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryCategory] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[List[_models.AtlasGlossaryCategory]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_create_categories_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasGlossaryCategory], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_category( + self, body: _models.AtlasGlossaryCategory, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Create a glossary category. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryCategory + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @overload + async def create_category( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Create a glossary category. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @overload + async def create_category( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Create a glossary category. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @distributed_trace_async + async def create_category( + self, body: Union[_models.AtlasGlossaryCategory, JSON, IO[bytes]], **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Create a glossary category. + + :param body: Is one of the following types: AtlasGlossaryCategory, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryCategory or JSON or IO[bytes] + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossaryCategory] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_create_category_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryCategory, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_category(self, category_id: str, **kwargs: Any) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Get specific glossary category by its GUID. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasGlossaryCategory] = kwargs.pop("cls", None) + + _request = build_glossary_get_category_request( + category_id=category_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryCategory, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def update_category( + self, + category_id: str, + body: _models.AtlasGlossaryCategory, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the given glossary category by its GUID. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryCategory + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @overload + async def update_category( + self, category_id: str, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the given glossary category by its GUID. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @overload + async def update_category( + self, category_id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the given glossary category by its GUID. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @distributed_trace_async + async def update_category( + self, category_id: str, body: Union[_models.AtlasGlossaryCategory, JSON, IO[bytes]], **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the given glossary category by its GUID. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: Is one of the following types: AtlasGlossaryCategory, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryCategory or JSON or IO[bytes] + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossaryCategory] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_update_category_request( + category_id=category_id, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryCategory, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete_category( # pylint: disable=inconsistent-return-statements + self, category_id: str, **kwargs: Any + ) -> None: + """Delete a glossary category. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_glossary_delete_category_request( + category_id=category_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def partial_update_category( + self, category_id: str, body: Dict[str, str], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the glossary category partially. So far we only supports partial + updating shortDescription and longDescription for category. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values for partial update. Required. + :type body: dict[str, str] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": "str" # Optional. + } + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @overload + async def partial_update_category( + self, category_id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the glossary category partially. So far we only supports partial + updating shortDescription and longDescription for category. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values for partial update. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @distributed_trace_async + async def partial_update_category( + self, category_id: str, body: Union[Dict[str, str], IO[bytes]], **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the glossary category partially. So far we only supports partial + updating shortDescription and longDescription for category. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values for partial update. Is either a {str: str} type or a IO[bytes] type. Required. + :type body: dict[str, str] or IO[bytes] + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossaryCategory] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_partial_update_category_request( + category_id=category_id, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryCategory, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_related_categories( + self, + category_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> Dict[str, List[_models.AtlasRelatedCategoryHeader]]: + """Get all related categories (parent and children). Limit, offset, and sort + parameters are currently not being enabled and won't work even they are passed. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: dict mapping str to list of AtlasRelatedCategoryHeader + :rtype: dict[str, list[~azure.purview.datamap.models.AtlasRelatedCategoryHeader]] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "str": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[Dict[str, List[_models.AtlasRelatedCategoryHeader]]] = kwargs.pop("cls", None) + + _request = build_glossary_get_related_categories_request( + category_id=category_id, + limit=limit, + offset=offset, + sort=sort, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(Dict[str, List[_models.AtlasRelatedCategoryHeader]], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_category_terms( + self, + category_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> List[_models.AtlasRelatedTermHeader]: + # pylint: disable=line-too-long + """Get all terms associated with the specific category. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: list of AtlasRelatedTermHeader + :rtype: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "description": "str", # Optional. The description of the related + term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the relationship. + "status": "str", # Optional. The status of term relationship. Known + values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasRelatedTermHeader]] = kwargs.pop("cls", None) + + _request = build_glossary_get_category_terms_request( + category_id=category_id, + limit=limit, + offset=offset, + sort=sort, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasRelatedTermHeader], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_term( + self, + body: _models.AtlasGlossaryTerm, + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Create a glossary term. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryTerm + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @overload + async def create_term( + self, + body: JSON, + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Create a glossary term. + + :param body: Required. + :type body: JSON + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @overload + async def create_term( + self, + body: IO[bytes], + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Create a glossary term. + + :param body: Required. + :type body: IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @distributed_trace_async + async def create_term( + self, + body: Union[_models.AtlasGlossaryTerm, JSON, IO[bytes]], + *, + include_term_hierarchy: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Create a glossary term. + + :param body: Is one of the following types: AtlasGlossaryTerm, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryTerm or JSON or IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossaryTerm] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_create_term_request( + include_term_hierarchy=include_term_hierarchy, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryTerm, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_term(self, term_id: str, **kwargs: Any) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Get a specific glossary term by its GUID. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasGlossaryTerm] = kwargs.pop("cls", None) + + _request = build_glossary_get_term_request( + term_id=term_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryTerm, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def update_term( + self, + term_id: str, + body: _models.AtlasGlossaryTerm, + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the given glossary term by its GUID. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryTerm + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @overload + async def update_term( + self, + term_id: str, + body: JSON, + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the given glossary term by its GUID. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: Required. + :type body: JSON + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @overload + async def update_term( + self, + term_id: str, + body: IO[bytes], + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the given glossary term by its GUID. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: Required. + :type body: IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @distributed_trace_async + async def update_term( + self, + term_id: str, + body: Union[_models.AtlasGlossaryTerm, JSON, IO[bytes]], + *, + include_term_hierarchy: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the given glossary term by its GUID. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: Is one of the following types: AtlasGlossaryTerm, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryTerm or JSON or IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossaryTerm] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_update_term_request( + term_id=term_id, + include_term_hierarchy=include_term_hierarchy, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryTerm, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete_term(self, term_id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete a glossary term. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_glossary_delete_term_request( + term_id=term_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def partial_update_term( + self, + term_id: str, + body: Dict[str, str], + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the glossary term partially. So far we only supports partial updating + shortDescription, longDescription, abbreviation, usage and status for term. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values to be updated. Required. + :type body: dict[str, str] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": "str" # Optional. + } + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @overload + async def partial_update_term( + self, + term_id: str, + body: IO[bytes], + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the glossary term partially. So far we only supports partial updating + shortDescription, longDescription, abbreviation, usage and status for term. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values to be updated. Required. + :type body: IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @distributed_trace_async + async def partial_update_term( + self, + term_id: str, + body: Union[Dict[str, str], IO[bytes]], + *, + include_term_hierarchy: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the glossary term partially. So far we only supports partial updating + shortDescription, longDescription, abbreviation, usage and status for term. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values to be updated. Is either a {str: str} type or a IO[bytes] type. Required. + :type body: dict[str, str] or IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossaryTerm] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_partial_update_term_request( + term_id=term_id, + include_term_hierarchy=include_term_hierarchy, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryTerm, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_terms( + self, + body: List[_models.AtlasGlossaryTerm], + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> List[_models.AtlasGlossaryTerm]: + # pylint: disable=line-too-long + """Create glossary terms in bulk. + + :param body: An array of glossary term definitions to be created in bulk. Required. + :type body: list[~azure.purview.datamap.models.AtlasGlossaryTerm] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: list of AtlasGlossaryTerm + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryTerm] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "typeName": "str" # Optional. The name of + the type. + }, + "relationshipGuid": "str", # Optional. The GUID of + the relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship + type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the + term, which is map>. The key of the first + layer map is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of + :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "replacedBy": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for + url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of + description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known + values are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + ] + + # response body for status code(s): 200 + response == [ + { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "typeName": "str" # Optional. The name of + the type. + }, + "relationshipGuid": "str", # Optional. The GUID of + the relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship + type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the + term, which is map>. The key of the first + layer map is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of + :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "replacedBy": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for + url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of + description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known + values are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + ] + """ + + @overload + async def create_terms( + self, + body: IO[bytes], + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> List[_models.AtlasGlossaryTerm]: + # pylint: disable=line-too-long + """Create glossary terms in bulk. + + :param body: An array of glossary term definitions to be created in bulk. Required. + :type body: IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: list of AtlasGlossaryTerm + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryTerm] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "typeName": "str" # Optional. The name of + the type. + }, + "relationshipGuid": "str", # Optional. The GUID of + the relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship + type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the + term, which is map>. The key of the first + layer map is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of + :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "replacedBy": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for + url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of + description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known + values are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + ] + """ + + @distributed_trace_async + async def create_terms( + self, + body: Union[List[_models.AtlasGlossaryTerm], IO[bytes]], + *, + include_term_hierarchy: Optional[bool] = None, + **kwargs: Any + ) -> List[_models.AtlasGlossaryTerm]: + # pylint: disable=line-too-long + """Create glossary terms in bulk. + + :param body: An array of glossary term definitions to be created in bulk. Is either a + [AtlasGlossaryTerm] type or a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasGlossaryTerm] or IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :return: list of AtlasGlossaryTerm + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryTerm] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "typeName": "str" # Optional. The name of + the type. + }, + "relationshipGuid": "str", # Optional. The GUID of + the relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship + type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the + term, which is map>. The key of the first + layer map is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of + :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "replacedBy": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for + url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of + description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known + values are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[List[_models.AtlasGlossaryTerm]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_create_terms_request( + include_term_hierarchy=include_term_hierarchy, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasGlossaryTerm], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_entities_assigned_with_term( + self, + term_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> List[_models.AtlasRelatedObjectId]: + # pylint: disable=line-too-long + """List all related objects assigned with the specified term. Recommend using + limit/offset to get pagination result. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: list of AtlasRelatedObjectId + :rtype: list[~azure.purview.datamap.models.AtlasRelatedObjectId] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the relationship. + "relationshipStatus": "str", # Optional. The enum of relationship + status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasRelatedObjectId]] = kwargs.pop("cls", None) + + _request = build_glossary_get_entities_assigned_with_term_request( + term_id=term_id, + limit=limit, + offset=offset, + sort=sort, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasRelatedObjectId], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def assign_term_to_entities( # pylint: disable=inconsistent-return-statements + self, + term_id: str, + body: List[_models.AtlasRelatedObjectId], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Assign the given term to the provided list of related objects. Recommend using + small batches with multiple API calls. + + `Entities Create Or Update + operation + `_ + is an alternative to assign a term to multiple entities. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: An array of related object IDs to which the term has to be associated. Required. + :type body: list[~azure.purview.datamap.models.AtlasRelatedObjectId] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the relationship. + "relationshipStatus": "str", # Optional. The enum of relationship + status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + } + ] + """ + + @overload + async def assign_term_to_entities( # pylint: disable=inconsistent-return-statements + self, term_id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Assign the given term to the provided list of related objects. Recommend using + small batches with multiple API calls. + + `Entities Create Or Update + operation + `_ + is an alternative to assign a term to multiple entities. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: An array of related object IDs to which the term has to be associated. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def assign_term_to_entities( # pylint: disable=inconsistent-return-statements + self, term_id: str, body: Union[List[_models.AtlasRelatedObjectId], IO[bytes]], **kwargs: Any + ) -> None: + """Assign the given term to the provided list of related objects. Recommend using + small batches with multiple API calls. + + `Entities Create Or Update + operation + `_ + is an alternative to assign a term to multiple entities. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: An array of related object IDs to which the term has to be associated. Is either a + [AtlasRelatedObjectId] type or a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasRelatedObjectId] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_assign_term_to_entities_request( + term_id=term_id, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def delete_term_assignment_from_entities( # pylint: disable=inconsistent-return-statements + self, + term_id: str, + body: List[_models.AtlasRelatedObjectId], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Delete the term assignment for the given list of related objects. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: An array of related object IDs from which the term has to be dissociated. + Required. + :type body: list[~azure.purview.datamap.models.AtlasRelatedObjectId] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the relationship. + "relationshipStatus": "str", # Optional. The enum of relationship + status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + } + ] + """ + + @overload + async def delete_term_assignment_from_entities( # pylint: disable=inconsistent-return-statements + self, term_id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Delete the term assignment for the given list of related objects. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: An array of related object IDs from which the term has to be dissociated. + Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def delete_term_assignment_from_entities( # pylint: disable=inconsistent-return-statements + self, term_id: str, body: Union[List[_models.AtlasRelatedObjectId], IO[bytes]], **kwargs: Any + ) -> None: + """Delete the term assignment for the given list of related objects. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: An array of related object IDs from which the term has to be dissociated. Is + either a [AtlasRelatedObjectId] type or a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasRelatedObjectId] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_delete_term_assignment_from_entities_request( + term_id=term_id, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def get_related_terms( + self, + term_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> Dict[str, List[_models.AtlasRelatedTermHeader]]: + # pylint: disable=line-too-long + """Get all related terms for a specific term by its GUID. Limit, offset, and sort + parameters are currently not being enabled and won't work even they are passed. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: dict mapping str to list of AtlasRelatedTermHeader + :rtype: dict[str, list[~azure.purview.datamap.models.AtlasRelatedTermHeader]] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "str": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[Dict[str, List[_models.AtlasRelatedTermHeader]]] = kwargs.pop("cls", None) + + _request = build_glossary_get_related_terms_request( + term_id=term_id, + limit=limit, + offset=offset, + sort=sort, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(Dict[str, List[_models.AtlasRelatedTermHeader]], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get(self, glossary_id: str, **kwargs: Any) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Get a specific Glossary by its GUID. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasGlossary] = kwargs.pop("cls", None) + + _request = build_glossary_get_request( + glossary_id=glossary_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossary, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def update( + self, + glossary_id: str, + body: _models.AtlasGlossary, + *, + ignore_terms_and_categories: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the given glossary. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasGlossary + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @overload + async def update( + self, + glossary_id: str, + body: JSON, + *, + ignore_terms_and_categories: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the given glossary. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: Required. + :type body: JSON + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @overload + async def update( + self, + glossary_id: str, + body: IO[bytes], + *, + ignore_terms_and_categories: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the given glossary. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: Required. + :type body: IO[bytes] + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @distributed_trace_async + async def update( + self, + glossary_id: str, + body: Union[_models.AtlasGlossary, JSON, IO[bytes]], + *, + ignore_terms_and_categories: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the given glossary. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: Is one of the following types: AtlasGlossary, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasGlossary or JSON or IO[bytes] + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossary] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_update_request( + glossary_id=glossary_id, + ignore_terms_and_categories=ignore_terms_and_categories, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossary, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete(self, glossary_id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete a glossary. Will delete underlying terms/categories together. Recommend + separate delete terms and categories. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_glossary_delete_request( + glossary_id=glossary_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def get_categories( + self, + glossary_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> List[_models.AtlasGlossaryCategory]: + # pylint: disable=line-too-long + """Get the categories belonging to a specific glossary. Recommend using + limit/offset to get pagination result. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: list of AtlasGlossaryCategory + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryCategory] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasGlossaryCategory]] = kwargs.pop("cls", None) + + _request = build_glossary_get_categories_request( + glossary_id=glossary_id, + limit=limit, + offset=offset, + sort=sort, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasGlossaryCategory], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_categories_headers( + self, + glossary_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> List[_models.AtlasRelatedCategoryHeader]: + """Get the category headers belonging to a specific glossary. Recommend using + limit/offset to get pagination result. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: list of AtlasRelatedCategoryHeader + :rtype: list[~azure.purview.datamap.models.AtlasRelatedCategoryHeader] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasRelatedCategoryHeader]] = kwargs.pop("cls", None) + + _request = build_glossary_get_categories_headers_request( + glossary_id=glossary_id, + limit=limit, + offset=offset, + sort=sort, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasRelatedCategoryHeader], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_detailed(self, glossary_id: str, **kwargs: Any) -> _models.AtlasGlossaryExtInfo: + # pylint: disable=line-too-long + """Get a specific glossary with detailed information. This API is not + recommend. + + Recommend to fetch terms/categories details separately using + + GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and + + GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :return: AtlasGlossaryExtInfo. The AtlasGlossaryExtInfo is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryExtInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "categoryInfo": { + "str": { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the + glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID + of the category. + "description": "str", # Optional. The + description of the category header. + "displayText": "str", # Optional. The + display text. + "parentCategoryGuid": "str", # Optional. The + GUID of the parent category. + "relationGuid": "str" # Optional. The GUID + of the relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "longDescription": "str", # Optional. The long version + description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of + the glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the + record. + } + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "termInfo": { + "str": { + "abbreviation": "str", # Optional. The abbreviation of the + term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the + glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The + display text. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the + object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "typeName": "str" # Optional. The + name of the type. + }, + "relationshipGuid": "str", # Optional. The + GUID of the relationship. + "relationshipStatus": "str", # Optional. The + enum of relationship status. Known values are: "ACTIVE" and + "DELETED". + "relationshipType": "str", # Optional. + Relationship type. + "typeName": "str", # Optional. The name of + the type. + "uniqueAttributes": { + "str": {} # Optional. The unique + attributes of the object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes + of the term, which is map>. The key of + the first layer map is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID + of the category. + "description": "str", # Optional. The + description of the record. + "displayText": "str", # Optional. The + display text. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str" # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display + text. + "guid": "str", # Optional. The GUID of the + object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of + :code:``. + }, + "resourceId": "str", # Optional. Resource + Id. + "typeName": "str", # Optional. The name of + the type. + "uniqueAttributes": { + "str": {} # Optional. The unique + attributes of the object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "longDescription": "str", # Optional. The long version + description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of + the glossary object. + "replacedBy": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display + name for url. + "url": "str" # Optional. web url. http or + https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "shortDescription": "str", # Optional. The short version of + description. + "status": "str", # Optional. Status of the + AtlasGlossaryTerm. Known values are: "Draft", "Approved", "Alert", and + "Expired". + "synonyms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ] + } + }, + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasGlossaryExtInfo] = kwargs.pop("cls", None) + + _request = build_glossary_get_detailed_request( + glossary_id=glossary_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryExtInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def partial_update( + self, + glossary_id: str, + body: Dict[str, str], + *, + ignore_terms_and_categories: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the glossary partially. Some properties such as qualifiedName are not + allowed to be updated. + + So far we only supports partial updating + shortDescription, longDescription, language and usage for glossary. + + Recommend + using 'ignoreTermsAndCategories=true' to reduce response body size. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values. Required. + :type body: dict[str, str] + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": "str" # Optional. + } + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @overload + async def partial_update( + self, + glossary_id: str, + body: IO[bytes], + *, + ignore_terms_and_categories: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the glossary partially. Some properties such as qualifiedName are not + allowed to be updated. + + So far we only supports partial updating + shortDescription, longDescription, language and usage for glossary. + + Recommend + using 'ignoreTermsAndCategories=true' to reduce response body size. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values. Required. + :type body: IO[bytes] + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @distributed_trace_async + async def partial_update( + self, + glossary_id: str, + body: Union[Dict[str, str], IO[bytes]], + *, + ignore_terms_and_categories: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the glossary partially. Some properties such as qualifiedName are not + allowed to be updated. + + So far we only supports partial updating + shortDescription, longDescription, language and usage for glossary. + + Recommend + using 'ignoreTermsAndCategories=true' to reduce response body size. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values. Is either a {str: str} type or a IO[bytes] type. Required. + :type body: dict[str, str] or IO[bytes] + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossary] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_partial_update_request( + glossary_id=glossary_id, + ignore_terms_and_categories=ignore_terms_and_categories, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossary, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_terms( + self, + glossary_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> List[_models.AtlasGlossaryTerm]: + # pylint: disable=line-too-long + """Get terms belonging to a specific glossary. Recommend using limit/offset to get + pagination result. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: list of AtlasGlossaryTerm + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryTerm] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "typeName": "str" # Optional. The name of + the type. + }, + "relationshipGuid": "str", # Optional. The GUID of + the relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship + type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the + term, which is map>. The key of the first + layer map is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of + :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "replacedBy": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for + url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of + description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known + values are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasGlossaryTerm]] = kwargs.pop("cls", None) + + _request = build_glossary_get_terms_request( + glossary_id=glossary_id, + limit=limit, + offset=offset, + sort=sort, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasGlossaryTerm], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_term_headers( + self, + glossary_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> List[_models.AtlasRelatedTermHeader]: + # pylint: disable=line-too-long + """Get term headers belonging to a specific glossary. Recommend using limit/offset + to get pagination result. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: list of AtlasRelatedTermHeader + :rtype: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "description": "str", # Optional. The description of the related + term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the relationship. + "status": "str", # Optional. The status of term relationship. Known + values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasRelatedTermHeader]] = kwargs.pop("cls", None) + + _request = build_glossary_get_term_headers_request( + glossary_id=glossary_id, + limit=limit, + offset=offset, + sort=sort, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasRelatedTermHeader], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + +class DiscoveryOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.purview.datamap.aio.DataMapClient`'s + :attr:`discovery` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + async def query( + self, body: _models.QueryOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.QueryResult: + # pylint: disable=line-too-long + """Get data using search. + + :param body: Required. + :type body: ~azure.purview.datamap.models.QueryOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: QueryResult. The QueryResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.QueryResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "continuationToken": "str", # Optional. The token used to get next batch of + data. Default 'Null' to get the first batch, and will return new token in each + response unless there's no more data. + "facets": [ + { + "count": 0, # Optional. The count of the facet item. + "facet": "str", # Optional. The name of the facet item. + "sort": { + "count": "str", # Optional. Order by count. Known + values are: "asc" and "desc". + "value": "str" # Optional. Order by value. Known + values are: "asc" and "desc". + } + } + ], + "filter": {}, # Optional. The filter for the search. See examples for the + usage of supported filters. + "keywords": "str", # Optional. The keywords applied to all searchable + fields. + "limit": 0, # Optional. The limit of the number of the search result. + default value is 50; maximum value is 1000. + "orderby": [ + {} # Optional. The sort order of search results, can specify + multiple fields. + ], + "taxonomySetting": { + "assetTypes": [ + "str" # Optional. Asset types. + ], + "facet": { + "count": 0, # Optional. The count of the facet item. + "facet": "str", # Optional. The name of the facet item. + "sort": { + "count": "str", # Optional. Order by count. Known + values are: "asc" and "desc". + "value": "str" # Optional. Order by value. Known + values are: "asc" and "desc". + } + } + } + } + + # response body for status code(s): 200 + response == { + "@search.count": 0, # Optional. The total number of search results (not the + number of documents in a single page). + "@search.count.approximate": bool, # Optional. 'True' if the '@search.count' + is an approximate value and vise versa. + "@search.facets": { + "assetType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "classification": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactId": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "entityType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "glossaryType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "label": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "term": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termStatus": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termTemplate": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ] + }, + "continuationToken": "str", # Optional. The token used to get next batch of + data. Absent if there's no more data. + "value": [ + { + "@search.highlights": { + "description": [ + "str" # Optional. Description. + ], + "entityType": [ + "str" # Optional. Entity type. + ], + "id": [ + "str" # Optional. Id. + ], + "name": [ + "str" # Optional. Name. + ], + "qualifiedName": [ + "str" # Optional. Qualified name. + ] + }, + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + + @overload + async def query(self, body: JSON, *, content_type: str = "application/json", **kwargs: Any) -> _models.QueryResult: + # pylint: disable=line-too-long + """Get data using search. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: QueryResult. The QueryResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.QueryResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "@search.count": 0, # Optional. The total number of search results (not the + number of documents in a single page). + "@search.count.approximate": bool, # Optional. 'True' if the '@search.count' + is an approximate value and vise versa. + "@search.facets": { + "assetType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "classification": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactId": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "entityType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "glossaryType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "label": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "term": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termStatus": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termTemplate": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ] + }, + "continuationToken": "str", # Optional. The token used to get next batch of + data. Absent if there's no more data. + "value": [ + { + "@search.highlights": { + "description": [ + "str" # Optional. Description. + ], + "entityType": [ + "str" # Optional. Entity type. + ], + "id": [ + "str" # Optional. Id. + ], + "name": [ + "str" # Optional. Name. + ], + "qualifiedName": [ + "str" # Optional. Qualified name. + ] + }, + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + + @overload + async def query( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.QueryResult: + # pylint: disable=line-too-long + """Get data using search. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: QueryResult. The QueryResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.QueryResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "@search.count": 0, # Optional. The total number of search results (not the + number of documents in a single page). + "@search.count.approximate": bool, # Optional. 'True' if the '@search.count' + is an approximate value and vise versa. + "@search.facets": { + "assetType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "classification": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactId": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "entityType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "glossaryType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "label": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "term": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termStatus": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termTemplate": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ] + }, + "continuationToken": "str", # Optional. The token used to get next batch of + data. Absent if there's no more data. + "value": [ + { + "@search.highlights": { + "description": [ + "str" # Optional. Description. + ], + "entityType": [ + "str" # Optional. Entity type. + ], + "id": [ + "str" # Optional. Id. + ], + "name": [ + "str" # Optional. Name. + ], + "qualifiedName": [ + "str" # Optional. Qualified name. + ] + }, + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + + @distributed_trace_async + async def query(self, body: Union[_models.QueryOptions, JSON, IO[bytes]], **kwargs: Any) -> _models.QueryResult: + # pylint: disable=line-too-long + """Get data using search. + + :param body: Is one of the following types: QueryOptions, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.QueryOptions or JSON or IO[bytes] + :return: QueryResult. The QueryResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.QueryResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "continuationToken": "str", # Optional. The token used to get next batch of + data. Default 'Null' to get the first batch, and will return new token in each + response unless there's no more data. + "facets": [ + { + "count": 0, # Optional. The count of the facet item. + "facet": "str", # Optional. The name of the facet item. + "sort": { + "count": "str", # Optional. Order by count. Known + values are: "asc" and "desc". + "value": "str" # Optional. Order by value. Known + values are: "asc" and "desc". + } + } + ], + "filter": {}, # Optional. The filter for the search. See examples for the + usage of supported filters. + "keywords": "str", # Optional. The keywords applied to all searchable + fields. + "limit": 0, # Optional. The limit of the number of the search result. + default value is 50; maximum value is 1000. + "orderby": [ + {} # Optional. The sort order of search results, can specify + multiple fields. + ], + "taxonomySetting": { + "assetTypes": [ + "str" # Optional. Asset types. + ], + "facet": { + "count": 0, # Optional. The count of the facet item. + "facet": "str", # Optional. The name of the facet item. + "sort": { + "count": "str", # Optional. Order by count. Known + values are: "asc" and "desc". + "value": "str" # Optional. Order by value. Known + values are: "asc" and "desc". + } + } + } + } + + # response body for status code(s): 200 + response == { + "@search.count": 0, # Optional. The total number of search results (not the + number of documents in a single page). + "@search.count.approximate": bool, # Optional. 'True' if the '@search.count' + is an approximate value and vise versa. + "@search.facets": { + "assetType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "classification": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactId": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "entityType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "glossaryType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "label": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "term": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termStatus": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termTemplate": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ] + }, + "continuationToken": "str", # Optional. The token used to get next batch of + data. Absent if there's no more data. + "value": [ + { + "@search.highlights": { + "description": [ + "str" # Optional. Description. + ], + "entityType": [ + "str" # Optional. Entity type. + ], + "id": [ + "str" # Optional. Id. + ], + "name": [ + "str" # Optional. Name. + ], + "qualifiedName": [ + "str" # Optional. Qualified name. + ] + }, + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.QueryResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_discovery_query_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.QueryResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def suggest( + self, body: _models.SuggestOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.SuggestResult: + # pylint: disable=line-too-long + """Get search suggestions by query criteria. + + :param body: Required. + :type body: ~azure.purview.datamap.models.SuggestOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SuggestResult. The SuggestResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.SuggestResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filter": {}, # Optional. The filter for the search. + "keywords": "str", # Optional. The keywords applied to all fields that + support suggest operation. It must be at least 1 character, and no more than 100 + characters. In the index schema we defined a default suggester which lists all + the supported fields and specifies a search mode. + "limit": 0 # Optional. The number of suggestions we hope to return. The + default value is 5. The value must be a number between 1 and 100. + } + + # response body for status code(s): 200 + response == { + "value": [ + { + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "@search.text": "str", # Optional. The target text that + contains the keyword as prefix. The keyword is wrapped with emphasis + mark. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + + @overload + async def suggest( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.SuggestResult: + # pylint: disable=line-too-long + """Get search suggestions by query criteria. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SuggestResult. The SuggestResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.SuggestResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "@search.text": "str", # Optional. The target text that + contains the keyword as prefix. The keyword is wrapped with emphasis + mark. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + + @overload + async def suggest( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.SuggestResult: + # pylint: disable=line-too-long + """Get search suggestions by query criteria. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: SuggestResult. The SuggestResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.SuggestResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "@search.text": "str", # Optional. The target text that + contains the keyword as prefix. The keyword is wrapped with emphasis + mark. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + + @distributed_trace_async + async def suggest( + self, body: Union[_models.SuggestOptions, JSON, IO[bytes]], **kwargs: Any + ) -> _models.SuggestResult: + # pylint: disable=line-too-long + """Get search suggestions by query criteria. + + :param body: Is one of the following types: SuggestOptions, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.SuggestOptions or JSON or IO[bytes] + :return: SuggestResult. The SuggestResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.SuggestResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filter": {}, # Optional. The filter for the search. + "keywords": "str", # Optional. The keywords applied to all fields that + support suggest operation. It must be at least 1 character, and no more than 100 + characters. In the index schema we defined a default suggester which lists all + the supported fields and specifies a search mode. + "limit": 0 # Optional. The number of suggestions we hope to return. The + default value is 5. The value must be a number between 1 and 100. + } + + # response body for status code(s): 200 + response == { + "value": [ + { + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "@search.text": "str", # Optional. The target text that + contains the keyword as prefix. The keyword is wrapped with emphasis + mark. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.SuggestResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_discovery_suggest_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.SuggestResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def auto_complete( + self, body: _models.AutoCompleteOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AutoCompleteResult: + # pylint: disable=line-too-long + """Get auto complete options. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AutoCompleteOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AutoCompleteResult. The AutoCompleteResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AutoCompleteResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filter": {}, # Optional. The filter for the autocomplete request. + "keywords": "str", # Optional. The keywords applied to all fields that + support autocomplete operation. It must be at least 1 character, and no more than + 100 characters. + "limit": 0 # Optional. The number of autocomplete results we hope to return. + The default value is 50. The value must be a number between 1 and 100. + } + + # response body for status code(s): 200 + response == { + "value": [ + { + "queryPlusText": "str", # Optional. The completed search + query text. + "text": "str" # Optional. The completed term or phrase. + } + ] + } + """ + + @overload + async def auto_complete( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AutoCompleteResult: + """Get auto complete options. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AutoCompleteResult. The AutoCompleteResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AutoCompleteResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "queryPlusText": "str", # Optional. The completed search + query text. + "text": "str" # Optional. The completed term or phrase. + } + ] + } + """ + + @overload + async def auto_complete( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AutoCompleteResult: + """Get auto complete options. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AutoCompleteResult. The AutoCompleteResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AutoCompleteResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "queryPlusText": "str", # Optional. The completed search + query text. + "text": "str" # Optional. The completed term or phrase. + } + ] + } + """ + + @distributed_trace_async + async def auto_complete( + self, body: Union[_models.AutoCompleteOptions, JSON, IO[bytes]], **kwargs: Any + ) -> _models.AutoCompleteResult: + # pylint: disable=line-too-long + """Get auto complete options. + + :param body: Is one of the following types: AutoCompleteOptions, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AutoCompleteOptions or JSON or IO[bytes] + :return: AutoCompleteResult. The AutoCompleteResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AutoCompleteResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filter": {}, # Optional. The filter for the autocomplete request. + "keywords": "str", # Optional. The keywords applied to all fields that + support autocomplete operation. It must be at least 1 character, and no more than + 100 characters. + "limit": 0 # Optional. The number of autocomplete results we hope to return. + The default value is 50. The value must be a number between 1 and 100. + } + + # response body for status code(s): 200 + response == { + "value": [ + { + "queryPlusText": "str", # Optional. The completed search + query text. + "text": "str" # Optional. The completed term or phrase. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AutoCompleteResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_discovery_auto_complete_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AutoCompleteResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + +class LineageOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.purview.datamap.aio.DataMapClient`'s + :attr:`lineage` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace_async + async def get( + self, guid: str, *, direction: Union[str, _models.LineageDirection], depth: Optional[int] = None, **kwargs: Any + ) -> _models.AtlasLineageInfo: + # pylint: disable=line-too-long + """Get lineage info of the entity specified by GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :keyword direction: The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Known + values are: "INPUT", "OUTPUT", and "BOTH". Required. + :paramtype direction: str or ~azure.purview.datamap.models.LineageDirection + :keyword depth: The number of hops for lineage. Default value is None. + :paramtype depth: int + :return: AtlasLineageInfo. The AtlasLineageInfo is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasLineageInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "baseEntityGuid": "str", # Optional. The GUID of the base entity. + "childrenCount": 0, # Optional. The number of children node. + "guidEntityMap": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + }, + "lineageDepth": 0, # Optional. The depth of lineage. + "lineageDirection": "str", # Optional. The enum of lineage direction. Known + values are: "INPUT", "OUTPUT", and "BOTH". + "lineageWidth": 0, # Optional. The width of lineage. + "parentRelations": [ + { + "childEntityId": "str", # Optional. The GUID of child + entity. + "parentEntityId": "str", # Optional. The GUID of parent + entity. + "relationshipId": "str" # Optional. The GUID of + relationship. + } + ], + "relations": [ + { + "fromEntityId": "str", # Optional. The GUID of from-entity. + "relationshipId": "str", # Optional. The GUID of + relationship. + "toEntityId": "str" # Optional. The GUID of to-entity. + } + ], + "widthCounts": { + "str": { + "str": {} # Optional. The entity count in specific + direction. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasLineageInfo] = kwargs.pop("cls", None) + + _request = build_lineage_get_request( + guid=guid, + direction=direction, + depth=depth, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasLineageInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_next_page( + self, + guid: str, + *, + direction: Union[str, _models.LineageDirection], + offset: Optional[int] = None, + limit: Optional[int] = None, + **kwargs: Any + ) -> _models.AtlasLineageInfo: + # pylint: disable=line-too-long + """Return immediate next page lineage info about entity with pagination. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :keyword direction: The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Known + values are: "INPUT", "OUTPUT", and "BOTH". Required. + :paramtype direction: str or ~azure.purview.datamap.models.LineageDirection + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :return: AtlasLineageInfo. The AtlasLineageInfo is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasLineageInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "baseEntityGuid": "str", # Optional. The GUID of the base entity. + "childrenCount": 0, # Optional. The number of children node. + "guidEntityMap": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + }, + "lineageDepth": 0, # Optional. The depth of lineage. + "lineageDirection": "str", # Optional. The enum of lineage direction. Known + values are: "INPUT", "OUTPUT", and "BOTH". + "lineageWidth": 0, # Optional. The width of lineage. + "parentRelations": [ + { + "childEntityId": "str", # Optional. The GUID of child + entity. + "parentEntityId": "str", # Optional. The GUID of parent + entity. + "relationshipId": "str" # Optional. The GUID of + relationship. + } + ], + "relations": [ + { + "fromEntityId": "str", # Optional. The GUID of from-entity. + "relationshipId": "str", # Optional. The GUID of + relationship. + "toEntityId": "str" # Optional. The GUID of to-entity. + } + ], + "widthCounts": { + "str": { + "str": {} # Optional. The entity count in specific + direction. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasLineageInfo] = kwargs.pop("cls", None) + + _request = build_lineage_get_next_page_request( + guid=guid, + direction=direction, + offset=offset, + limit=limit, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasLineageInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_by_unique_attribute( + self, + type_name: str, + *, + direction: Union[str, _models.LineageDirection], + depth: Optional[int] = None, + attribute: Optional[str] = None, + **kwargs: Any + ) -> _models.AtlasLineageInfo: + # pylint: disable=line-too-long + """Return lineage info about entity. + + In addition to the typeName path parameter, + attribute key-value pair(s) can be provided in the following + format + + attr:[attrName]=[attrValue] + + NOTE: The attrName and attrValue should be + unique across entities, eg. qualifiedName. + + The REST request would look + something like this: + + GET + /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :keyword direction: The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Known + values are: "INPUT", "OUTPUT", and "BOTH". Required. + :paramtype direction: str or ~azure.purview.datamap.models.LineageDirection + :keyword depth: The number of hops for lineage. Default value is None. + :paramtype depth: int + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: AtlasLineageInfo. The AtlasLineageInfo is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasLineageInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "baseEntityGuid": "str", # Optional. The GUID of the base entity. + "childrenCount": 0, # Optional. The number of children node. + "guidEntityMap": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + }, + "lineageDepth": 0, # Optional. The depth of lineage. + "lineageDirection": "str", # Optional. The enum of lineage direction. Known + values are: "INPUT", "OUTPUT", and "BOTH". + "lineageWidth": 0, # Optional. The width of lineage. + "parentRelations": [ + { + "childEntityId": "str", # Optional. The GUID of child + entity. + "parentEntityId": "str", # Optional. The GUID of parent + entity. + "relationshipId": "str" # Optional. The GUID of + relationship. + } + ], + "relations": [ + { + "fromEntityId": "str", # Optional. The GUID of from-entity. + "relationshipId": "str", # Optional. The GUID of + relationship. + "toEntityId": "str" # Optional. The GUID of to-entity. + } + ], + "widthCounts": { + "str": { + "str": {} # Optional. The entity count in specific + direction. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasLineageInfo] = kwargs.pop("cls", None) + + _request = build_lineage_get_by_unique_attribute_request( + type_name=type_name, + direction=direction, + depth=depth, + attribute=attribute, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasLineageInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + +class RelationshipOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.purview.datamap.aio.DataMapClient`'s + :attr:`relationship` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + async def create( + self, body: _models.AtlasRelationship, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasRelationship: + """Create a new relationship between entities. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasRelationship + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + + @overload + async def create( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasRelationship: + """Create a new relationship between entities. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + + @overload + async def create( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasRelationship: + """Create a new relationship between entities. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + + @distributed_trace_async + async def create( + self, body: Union[_models.AtlasRelationship, JSON, IO[bytes]], **kwargs: Any + ) -> _models.AtlasRelationship: + """Create a new relationship between entities. + + :param body: Is one of the following types: AtlasRelationship, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasRelationship or JSON or IO[bytes] + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasRelationship] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_relationship_create_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasRelationship, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def update( + self, body: _models.AtlasRelationship, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasRelationship: + """Update an existing relationship between entities. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasRelationship + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + + @overload + async def update( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasRelationship: + """Update an existing relationship between entities. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + + @overload + async def update( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasRelationship: + """Update an existing relationship between entities. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + + @distributed_trace_async + async def update( + self, body: Union[_models.AtlasRelationship, JSON, IO[bytes]], **kwargs: Any + ) -> _models.AtlasRelationship: + """Update an existing relationship between entities. + + :param body: Is one of the following types: AtlasRelationship, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasRelationship or JSON or IO[bytes] + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasRelationship] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_relationship_update_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasRelationship, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get( + self, guid: str, *, extended_info: Optional[bool] = None, **kwargs: Any + ) -> _models.AtlasRelationshipWithExtInfo: + # pylint: disable=line-too-long + """Get relationship information between entities by its GUID. + + :param guid: The globally unique identifier of the relationship. Required. + :type guid: str + :keyword extended_info: Limits whether includes extended information. Default value is None. + :paramtype extended_info: bool + :return: AtlasRelationshipWithExtInfo. The AtlasRelationshipWithExtInfo is compatible with + MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationshipWithExtInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + }, + "relationship": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasRelationshipWithExtInfo] = kwargs.pop("cls", None) + + _request = build_relationship_get_request( + guid=guid, + extended_info=extended_info, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasRelationshipWithExtInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete(self, guid: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete a relationship between entities by its GUID. + + :param guid: The globally unique identifier of the relationship. Required. + :type guid: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_relationship_delete_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + +class TypeDefinitionOperations: # pylint: disable=too-many-public-methods + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.purview.datamap.aio.DataMapClient`'s + :attr:`type_definition` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace_async + async def get_business_metadata_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasBusinessMetadataDef: + # pylint: disable=line-too-long + """Get the businessMetadata definition for the given guid. + + :param guid: businessMetadata guid. Required. + :type guid: str + :return: AtlasBusinessMetadataDef. The AtlasBusinessMetadataDef is compatible with + MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasBusinessMetadataDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasBusinessMetadataDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_business_metadata_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasBusinessMetadataDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_business_metadata_by_name(self, name: str, **kwargs: Any) -> _models.AtlasBusinessMetadataDef: + # pylint: disable=line-too-long + """Get the businessMetadata definition by it's name (unique). + + :param name: businessMetadata name. Required. + :type name: str + :return: AtlasBusinessMetadataDef. The AtlasBusinessMetadataDef is compatible with + MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasBusinessMetadataDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasBusinessMetadataDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_business_metadata_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasBusinessMetadataDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_classification_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasClassificationDef: + # pylint: disable=line-too-long + """Get the classification definition for the given GUID. + + :param guid: The globally unique identifier of the classification. Required. + :type guid: str + :return: AtlasClassificationDef. The AtlasClassificationDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasClassificationDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType names in the + classificationDef, ensures that classifications can only be applied to those + entityTypes. Any subtypes of the entity types inherit the restriction. Any + classificationDef subtypes inherit the parents entityTypes restrictions. Any + classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. An empty entityTypes + list when there are no parent restrictions means there are no restrictions. + An empty entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes are + supplied, where one inherits from another, this will be rejected. This should + encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasClassificationDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_classification_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasClassificationDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_classification_by_name(self, name: str, **kwargs: Any) -> _models.AtlasClassificationDef: + # pylint: disable=line-too-long + """Get the classification definition by its name (unique). + + :param name: The name of the classification. Required. + :type name: str + :return: AtlasClassificationDef. The AtlasClassificationDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasClassificationDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType names in the + classificationDef, ensures that classifications can only be applied to those + entityTypes. Any subtypes of the entity types inherit the restriction. Any + classificationDef subtypes inherit the parents entityTypes restrictions. Any + classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. An empty entityTypes + list when there are no parent restrictions means there are no restrictions. + An empty entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes are + supplied, where one inherits from another, this will be rejected. This should + encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasClassificationDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_classification_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasClassificationDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_entity_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEntityDef: + # pylint: disable=line-too-long + """Get the Entity definition for the given GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :return: AtlasEntityDef. The AtlasEntityDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntityDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isLegacyAttribute": bool, # Optional. Determines if it is a + legacy attribute. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "relationshipTypeName": "str", # Optional. The name of the + relationship type. + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntityDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_entity_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntityDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_entity_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEntityDef: + # pylint: disable=line-too-long + """Get the entity definition by its name (unique). + + :param name: The name of the entity. Required. + :type name: str + :return: AtlasEntityDef. The AtlasEntityDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntityDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isLegacyAttribute": bool, # Optional. Determines if it is a + legacy attribute. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "relationshipTypeName": "str", # Optional. The name of the + relationship type. + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntityDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_entity_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntityDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_enum_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEnumDef: + # pylint: disable=line-too-long + """Get the enum definition for the given GUID. + + :param guid: The globally unique identifier of the enum. Required. + :type guid: str + :return: AtlasEnumDef. The AtlasEnumDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEnumDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the type definition. + "elementDefs": [ + { + "description": "str", # Optional. The description of the + enum element definition. + "ordinal": 0, # Optional. The ordinal of the enum element + definition. + "value": "str" # Optional. The value of the enum element + definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEnumDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_enum_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEnumDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_enum_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEnumDef: + # pylint: disable=line-too-long + """Get the enum definition by its name (unique). + + :param name: The name of the enum. Required. + :type name: str + :return: AtlasEnumDef. The AtlasEnumDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEnumDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the type definition. + "elementDefs": [ + { + "description": "str", # Optional. The description of the + enum element definition. + "ordinal": 0, # Optional. The ordinal of the enum element + definition. + "value": "str" # Optional. The value of the enum element + definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEnumDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_enum_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEnumDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_relationship_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasRelationshipDef: + # pylint: disable=line-too-long + """Get the relationship definition for the given GUID. + + :param guid: The globally unique identifier of the relationship. Required. + :type guid: str + :return: AtlasRelationshipDef. The AtlasRelationshipDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationshipDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "relationshipCategory": "str", # Optional. The Relationship category + determines the style of relationship around containment and lifecycle. UML + terminology is used for the values. ASSOCIATION is a relationship with no + containment. COMPOSITION and AGGREGATION are containment relationships. The + difference being in the lifecycles of the container and its children. In the + COMPOSITION case, the children cannot exist without the container. For + AGGREGATION, the life cycles of the container and children are totally + independent. Known values are: "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasRelationshipDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_relationship_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasRelationshipDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_relationship_by_name(self, name: str, **kwargs: Any) -> _models.AtlasRelationshipDef: + # pylint: disable=line-too-long + """Get the relationship definition by its name (unique). + + :param name: The name of the relationship. Required. + :type name: str + :return: AtlasRelationshipDef. The AtlasRelationshipDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationshipDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "relationshipCategory": "str", # Optional. The Relationship category + determines the style of relationship around containment and lifecycle. UML + terminology is used for the values. ASSOCIATION is a relationship with no + containment. COMPOSITION and AGGREGATION are containment relationships. The + difference being in the lifecycles of the container and its children. In the + COMPOSITION case, the children cannot exist without the container. For + AGGREGATION, the life cycles of the container and children are totally + independent. Known values are: "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasRelationshipDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_relationship_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasRelationshipDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_struct_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasStructDef: + # pylint: disable=line-too-long + """Get the struct definition for the given GUID. + + :param guid: The globally unique identifier of the struct. Required. + :type guid: str + :return: AtlasStructDef. The AtlasStructDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasStructDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasStructDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_struct_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasStructDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_struct_by_name(self, name: str, **kwargs: Any) -> _models.AtlasStructDef: + # pylint: disable=line-too-long + """Get the struct definition by its name (unique). + + :param name: The name of the struct. Required. + :type name: str + :return: AtlasStructDef. The AtlasStructDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasStructDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasStructDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_struct_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasStructDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasTypeDef: + # pylint: disable=line-too-long + """Get the type definition for the given GUID. + + :param guid: The globally unique identifier of the type. Required. + :type guid: str + :return: AtlasTypeDef. The AtlasTypeDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypeDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the type definition. + "elementDefs": [ + { + "description": "str", # Optional. The description of the + enum element definition. + "ordinal": 0, # Optional. The ordinal of the enum element + definition. + "value": "str" # Optional. The value of the enum element + definition. + } + ], + "endDef1": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "entityTypes": [ + "str" # Optional. Specifying a list of entityType names in the + classificationDef, ensures that classifications can only be applied to those + entityTypes. Any subtypes of the entity types inherit the restriction. Any + classificationDef subtypes inherit the parents entityTypes restrictions. Any + classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. An empty entityTypes + list when there are no parent restrictions means there are no restrictions. + An empty entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes are + supplied, where one inherits from another, this will be rejected. This should + encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isLegacyAttribute": bool, # Optional. Determines if it is a + legacy attribute. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "relationshipTypeName": "str", # Optional. The name of the + relationship type. + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "relationshipCategory": "str", # Optional. The Relationship category + determines the style of relationship around containment and lifecycle. UML + terminology is used for the values. ASSOCIATION is a relationship with no + containment. COMPOSITION and AGGREGATION are containment relationships. The + difference being in the lifecycles of the container and its children. In the + COMPOSITION case, the children cannot exist without the container. For + AGGREGATION, the life cycles of the container and children are totally + independent. Known values are: "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the relationship. + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasTypeDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasTypeDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_by_name(self, name: str, **kwargs: Any) -> _models.AtlasTypeDef: + # pylint: disable=line-too-long + """Get the type definition by its name (unique). + + :param name: The name of the type. Required. + :type name: str + :return: AtlasTypeDef. The AtlasTypeDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypeDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the type definition. + "elementDefs": [ + { + "description": "str", # Optional. The description of the + enum element definition. + "ordinal": 0, # Optional. The ordinal of the enum element + definition. + "value": "str" # Optional. The value of the enum element + definition. + } + ], + "endDef1": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "entityTypes": [ + "str" # Optional. Specifying a list of entityType names in the + classificationDef, ensures that classifications can only be applied to those + entityTypes. Any subtypes of the entity types inherit the restriction. Any + classificationDef subtypes inherit the parents entityTypes restrictions. Any + classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. An empty entityTypes + list when there are no parent restrictions means there are no restrictions. + An empty entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes are + supplied, where one inherits from another, this will be rejected. This should + encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isLegacyAttribute": bool, # Optional. Determines if it is a + legacy attribute. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "relationshipTypeName": "str", # Optional. The name of the + relationship type. + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "relationshipCategory": "str", # Optional. The Relationship category + determines the style of relationship around containment and lifecycle. UML + terminology is used for the values. ASSOCIATION is a relationship with no + containment. COMPOSITION and AGGREGATION are containment relationships. The + difference being in the lifecycles of the container and its children. In the + COMPOSITION case, the children cannot exist without the container. For + AGGREGATION, the life cycles of the container and children are totally + independent. Known values are: "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the relationship. + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasTypeDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasTypeDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete(self, name: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete API for type identified by its name. + + :param name: The name of the type. Required. + :type name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_type_definition_delete_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def get( + self, + *, + include_term_template: Optional[bool] = None, + type: Optional[Union[str, _models.TypeCategory]] = None, + **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """List all type definitions in bulk. + + :keyword include_term_template: Whether include termtemplatedef when return all typedefs. + This is always true + when search filter type=term_template. Default value is None. + :paramtype include_term_template: bool + :keyword type: Typedef name as search filter when get typedefs. Known values are: "PRIMITIVE", + "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", + and "TERM_TEMPLATE". Default value is None. + :paramtype type: str or ~azure.purview.datamap.models.TypeCategory + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasTypesDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_request( + include_term_template=include_term_template, + type=type, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasTypesDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def batch_create( + self, body: _models.AtlasTypesDef, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Create all atlas type definitions in bulk, only new definitions will be + created. + Any changes to the existing definitions will be discarded. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasTypesDef + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @overload + async def batch_create( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Create all atlas type definitions in bulk, only new definitions will be + created. + Any changes to the existing definitions will be discarded. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @overload + async def batch_create( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Create all atlas type definitions in bulk, only new definitions will be + created. + Any changes to the existing definitions will be discarded. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @distributed_trace_async + async def batch_create( + self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Create all atlas type definitions in bulk, only new definitions will be + created. + Any changes to the existing definitions will be discarded. + + :param body: Is one of the following types: AtlasTypesDef, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasTypesDef or JSON or IO[bytes] + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasTypesDef] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_type_definition_batch_create_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasTypesDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def batch_update( + self, body: _models.AtlasTypesDef, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Update all types in bulk, changes detected in the type definitions would be + persisted. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasTypesDef + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @overload + async def batch_update( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Update all types in bulk, changes detected in the type definitions would be + persisted. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @overload + async def batch_update( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Update all types in bulk, changes detected in the type definitions would be + persisted. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @distributed_trace_async + async def batch_update( + self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Update all types in bulk, changes detected in the type definitions would be + persisted. + + :param body: Is one of the following types: AtlasTypesDef, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasTypesDef or JSON or IO[bytes] + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasTypesDef] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_type_definition_batch_update_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasTypesDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def batch_delete( # pylint: disable=inconsistent-return-statements + self, body: _models.AtlasTypesDef, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Delete API for all types in bulk. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasTypesDef + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @overload + async def batch_delete( # pylint: disable=inconsistent-return-statements + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Delete API for all types in bulk. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def batch_delete( # pylint: disable=inconsistent-return-statements + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Delete API for all types in bulk. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def batch_delete( # pylint: disable=inconsistent-return-statements + self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Delete API for all types in bulk. + + :param body: Is one of the following types: AtlasTypesDef, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasTypesDef or JSON or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_type_definition_batch_delete_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def get_headers( + self, + *, + include_term_template: Optional[bool] = None, + type: Optional[Union[str, _models.TypeCategory]] = None, + **kwargs: Any + ) -> List[_models.AtlasTypeDefHeader]: + # pylint: disable=line-too-long + """List all type definitions returned as a list of minimal information header. + + :keyword include_term_template: Whether include termtemplatedef when return all typedefs. + This is always true + when search filter type=term_template. Default value is None. + :paramtype include_term_template: bool + :keyword type: Typedef name as search filter when get typedefs. Known values are: "PRIMITIVE", + "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", + and "TERM_TEMPLATE". Default value is None. + :paramtype type: str or ~azure.purview.datamap.models.TypeCategory + :return: list of AtlasTypeDefHeader + :rtype: list[~azure.purview.datamap.models.AtlasTypeDefHeader] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "category": "str", # Optional. The enum of type category. Known + values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "guid": "str", # Optional. The GUID of the type definition. + "name": "str" # Optional. The name of the type definition. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasTypeDefHeader]] = kwargs.pop("cls", None) + + _request = build_type_definition_get_headers_request( + include_term_template=include_term_template, + type=type, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasTypeDefHeader], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_term_template_by_id(self, guid: str, **kwargs: Any) -> _models.TermTemplateDef: + # pylint: disable=line-too-long + """Get the term template definition for the given GUID. + + :param guid: The globally unique identifier of the term template. Required. + :type guid: str + :return: TermTemplateDef. The TermTemplateDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.TermTemplateDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TermTemplateDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_term_template_by_id_request( + guid=guid, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TermTemplateDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_term_template_by_name(self, name: str, **kwargs: Any) -> _models.TermTemplateDef: + # pylint: disable=line-too-long + """Get the term template definition by its name (unique). + + :param name: The unique name of the term template. Required. + :type name: str + :return: TermTemplateDef. The TermTemplateDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.TermTemplateDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TermTemplateDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_term_template_by_name_request( + name=name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TermTemplateDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/operations/_patch.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/__init__.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/__init__.py new file mode 100644 index 000000000000..5eee48d4696f --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/__init__.py @@ -0,0 +1,183 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import AtlasAttributeDef +from ._models import AtlasBusinessMetadataDef +from ._models import AtlasClassification +from ._models import AtlasClassificationDef +from ._models import AtlasClassifications +from ._models import AtlasConstraintDef +from ._models import AtlasEntitiesWithExtInfo +from ._models import AtlasEntity +from ._models import AtlasEntityDef +from ._models import AtlasEntityHeader +from ._models import AtlasEntityHeaders +from ._models import AtlasEntityWithExtInfo +from ._models import AtlasEnumDef +from ._models import AtlasEnumElementDef +from ._models import AtlasErrorResponse +from ._models import AtlasGlossary +from ._models import AtlasGlossaryCategory +from ._models import AtlasGlossaryExtInfo +from ._models import AtlasGlossaryHeader +from ._models import AtlasGlossaryTerm +from ._models import AtlasLineageInfo +from ._models import AtlasObjectId +from ._models import AtlasRelatedCategoryHeader +from ._models import AtlasRelatedObjectId +from ._models import AtlasRelatedTermHeader +from ._models import AtlasRelationship +from ._models import AtlasRelationshipAttributeDef +from ._models import AtlasRelationshipDef +from ._models import AtlasRelationshipEndDef +from ._models import AtlasRelationshipWithExtInfo +from ._models import AtlasStruct +from ._models import AtlasStructDef +from ._models import AtlasTermAssignmentHeader +from ._models import AtlasTermCategorizationHeader +from ._models import AtlasTypeDef +from ._models import AtlasTypeDefHeader +from ._models import AtlasTypesDef +from ._models import AutoCompleteOptions +from ._models import AutoCompleteResult +from ._models import AutoCompleteResultValue +from ._models import BulkImportResult +from ._models import ClassificationAssociateOptions +from ._models import ContactInfo +from ._models import ContactSearchResultValue +from ._models import DateFormat +from ._models import EntityMutationResult +from ._models import ImportInfo +from ._models import LineageRelation +from ._models import MoveEntitiesOptions +from ._models import NumberFormat +from ._models import ParentRelation +from ._models import PurviewObjectId +from ._models import QueryOptions +from ._models import QueryResult +from ._models import ResourceLink +from ._models import SearchFacetItem +from ._models import SearchFacetItemValue +from ._models import SearchFacetResultValue +from ._models import SearchFacetSort +from ._models import SearchHighlights +from ._models import SearchResultValue +from ._models import SearchTaxonomySetting +from ._models import SuggestOptions +from ._models import SuggestResult +from ._models import SuggestResultValue +from ._models import TermSearchResultValue +from ._models import TermTemplateDef +from ._models import TimeBoundary +from ._models import TimeZone + +from ._enums import AtlasTermAssignmentStatus +from ._enums import AtlasTermRelationshipStatus +from ._enums import BusinessAttributeUpdateBehavior +from ._enums import CardinalityValue +from ._enums import EntityStatus +from ._enums import ImportStatus +from ._enums import LineageDirection +from ._enums import RelationshipCategory +from ._enums import RoundingMode +from ._enums import SearchSortOrder +from ._enums import SortType +from ._enums import StatusAtlasRelationship +from ._enums import TermStatus +from ._enums import TypeCategory +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "AtlasAttributeDef", + "AtlasBusinessMetadataDef", + "AtlasClassification", + "AtlasClassificationDef", + "AtlasClassifications", + "AtlasConstraintDef", + "AtlasEntitiesWithExtInfo", + "AtlasEntity", + "AtlasEntityDef", + "AtlasEntityHeader", + "AtlasEntityHeaders", + "AtlasEntityWithExtInfo", + "AtlasEnumDef", + "AtlasEnumElementDef", + "AtlasErrorResponse", + "AtlasGlossary", + "AtlasGlossaryCategory", + "AtlasGlossaryExtInfo", + "AtlasGlossaryHeader", + "AtlasGlossaryTerm", + "AtlasLineageInfo", + "AtlasObjectId", + "AtlasRelatedCategoryHeader", + "AtlasRelatedObjectId", + "AtlasRelatedTermHeader", + "AtlasRelationship", + "AtlasRelationshipAttributeDef", + "AtlasRelationshipDef", + "AtlasRelationshipEndDef", + "AtlasRelationshipWithExtInfo", + "AtlasStruct", + "AtlasStructDef", + "AtlasTermAssignmentHeader", + "AtlasTermCategorizationHeader", + "AtlasTypeDef", + "AtlasTypeDefHeader", + "AtlasTypesDef", + "AutoCompleteOptions", + "AutoCompleteResult", + "AutoCompleteResultValue", + "BulkImportResult", + "ClassificationAssociateOptions", + "ContactInfo", + "ContactSearchResultValue", + "DateFormat", + "EntityMutationResult", + "ImportInfo", + "LineageRelation", + "MoveEntitiesOptions", + "NumberFormat", + "ParentRelation", + "PurviewObjectId", + "QueryOptions", + "QueryResult", + "ResourceLink", + "SearchFacetItem", + "SearchFacetItemValue", + "SearchFacetResultValue", + "SearchFacetSort", + "SearchHighlights", + "SearchResultValue", + "SearchTaxonomySetting", + "SuggestOptions", + "SuggestResult", + "SuggestResultValue", + "TermSearchResultValue", + "TermTemplateDef", + "TimeBoundary", + "TimeZone", + "AtlasTermAssignmentStatus", + "AtlasTermRelationshipStatus", + "BusinessAttributeUpdateBehavior", + "CardinalityValue", + "EntityStatus", + "ImportStatus", + "LineageDirection", + "RelationshipCategory", + "RoundingMode", + "SearchSortOrder", + "SortType", + "StatusAtlasRelationship", + "TermStatus", + "TypeCategory", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/_enums.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/_enums.py new file mode 100644 index 000000000000..2ef81a12edc9 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/_enums.py @@ -0,0 +1,194 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class AtlasTermAssignmentStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Status for term assignment.""" + + DISCOVERED = "DISCOVERED" + """The status is discovered.""" + PROPOSED = "PROPOSED" + """The status is proposed.""" + IMPORTED = "IMPORTED" + """The status is imported.""" + VALIDATED = "VALIDATED" + """The status is validated.""" + DEPRECATED = "DEPRECATED" + """The status is deprecated.""" + OBSOLETE = "OBSOLETE" + """The status is obsolete.""" + OTHER = "OTHER" + """Other status.""" + + +class AtlasTermRelationshipStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Status for atlas term relationship.""" + + DRAFT = "DRAFT" + """draft""" + ACTIVE = "ACTIVE" + """active""" + DEPRECATED = "DEPRECATED" + """deprecated""" + OBSOLETE = "OBSOLETE" + """obsolete""" + OTHER = "OTHER" + """other""" + + +class BusinessAttributeUpdateBehavior(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Enum for business attribute update behavior.""" + + IGNORE = "ignore" + """Ignore the business attribute payload for update.""" + REPLACE = "replace" + """Replace all the business attributes using the payload.""" + MERGE = "merge" + """Merge the business attributes. Business attributes will not be updated if not provided.""" + + +class CardinalityValue(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Cardinality.""" + + SINGLE = "SINGLE" + """single""" + LIST = "LIST" + """list""" + SET = "SET" + """set""" + + +class EntityStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Status - can be active or deleted.""" + + ACTIVE = "ACTIVE" + """The status is active.""" + DELETED = "DELETED" + """The status is deleted.""" + + +class ImportStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Status for import.""" + + SUCCESS = "SUCCESS" + """Success""" + FAILED = "FAILED" + """Failed""" + + +class LineageDirection(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Lineage direction.""" + + INPUT = "INPUT" + """input""" + OUTPUT = "OUTPUT" + """output""" + BOTH = "BOTH" + """both""" + + +class RelationshipCategory(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Relationship Category.""" + + ASSOCIATION = "ASSOCIATION" + """association""" + AGGREGATION = "AGGREGATION" + """aggregation""" + COMPOSITION = "COMPOSITION" + """composition""" + + +class RoundingMode(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Rounding Mode.""" + + UP = "UP" + """up""" + DOWN = "DOWN" + """down""" + CEILING = "CEILING" + """ceiling""" + FLOOR = "FLOOR" + """floor""" + HALF_UP = "HALF_UP" + """half up""" + HALF_DOWN = "HALF_DOWN" + """half down""" + HALF_EVEN = "HALF_EVEN" + """half even""" + UNNECESSARY = "UNNECESSARY" + """unnecessary""" + + +class SearchSortOrder(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Search sort order.""" + + ASCEND = "asc" + """Use ascending order for sorting""" + DESCEND = "desc" + """Use descending order for sorting""" + + +class SortType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Type for sorting.""" + + NONE = "NONE" + """No sorting order""" + ASCEND = "ASC" + """Use ascending order for sorting""" + DESCEND = "DESC" + """Use descending order for sorting""" + + +class StatusAtlasRelationship(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Status for atlas relationship.""" + + ACTIVE = "ACTIVE" + """active""" + DELETED = "DELETED" + """deleted""" + + +class TermStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Status for term.""" + + DRAFT = "Draft" + """draft""" + APPROVED = "Approved" + """approved""" + ALERT = "Alert" + """alert""" + EXPIRED = "Expired" + """expired""" + + +class TypeCategory(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Type Category.""" + + PRIMITIVE = "PRIMITIVE" + """primitive""" + OBJECT_ID_TYPE = "OBJECT_ID_TYPE" + """object id type""" + ENUM = "ENUM" + """enum""" + STRUCT = "STRUCT" + """struct""" + CLASSIFICATION = "CLASSIFICATION" + """classification""" + ENTITY = "ENTITY" + """entity""" + ARRAY = "ARRAY" + """array""" + MAP = "MAP" + """map""" + RELATIONSHIP = "RELATIONSHIP" + """relationship""" + TERM_TEMPLATE = "TERM_TEMPLATE" + """term template""" diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/_models.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/_models.py new file mode 100644 index 000000000000..0c3d47172548 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/_models.py @@ -0,0 +1,4799 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +import sys +from typing import Any, Dict, List, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .. import _model_base +from .._model_base import rest_field + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from .. import models as _models +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object + + +class AtlasAttributeDef(_model_base.Model): # pylint: disable=too-many-instance-attributes + """class that captures details of a struct-attribute. + + :ivar cardinality: single-valued attribute or multi-valued attribute. Known values are: + "SINGLE", "LIST", and "SET". + :vartype cardinality: str or ~azure.purview.datamap.models.CardinalityValue + :ivar constraints: An array of constraints. + :vartype constraints: list[~azure.purview.datamap.models.AtlasConstraintDef] + :ivar default_value: The default value of the attribute. + :vartype default_value: str + :ivar description: The description of the attribute. + :vartype description: str + :ivar include_in_notification: Determines if it is included in notification. + :vartype include_in_notification: bool + :ivar is_indexable: Determines if it is indexable. + :vartype is_indexable: bool + :ivar is_optional: Determines if it is optional. + :vartype is_optional: bool + :ivar is_unique: Determines if it unique. + :vartype is_unique: bool + :ivar name: The name of the attribute. + :vartype name: str + :ivar options: The options for the attribute. + :vartype options: dict[str, str] + :ivar type_name: The name of the type. + :vartype type_name: str + :ivar values_max_count: The maximum count of the values. + :vartype values_max_count: int + :ivar values_min_count: The minimum count of the values. + :vartype values_min_count: int + """ + + cardinality: Optional[Union[str, "_models.CardinalityValue"]] = rest_field() + """single-valued attribute or multi-valued attribute. Known values are: \"SINGLE\", \"LIST\", and + \"SET\".""" + constraints: Optional[List["_models.AtlasConstraintDef"]] = rest_field() + """An array of constraints.""" + default_value: Optional[str] = rest_field(name="defaultValue") + """The default value of the attribute.""" + description: Optional[str] = rest_field() + """The description of the attribute.""" + include_in_notification: Optional[bool] = rest_field(name="includeInNotification") + """Determines if it is included in notification.""" + is_indexable: Optional[bool] = rest_field(name="isIndexable") + """Determines if it is indexable.""" + is_optional: Optional[bool] = rest_field(name="isOptional") + """Determines if it is optional.""" + is_unique: Optional[bool] = rest_field(name="isUnique") + """Determines if it unique.""" + name: Optional[str] = rest_field() + """The name of the attribute.""" + options: Optional[Dict[str, str]] = rest_field() + """The options for the attribute.""" + type_name: Optional[str] = rest_field(name="typeName") + """The name of the type.""" + values_max_count: Optional[int] = rest_field(name="valuesMaxCount") + """The maximum count of the values.""" + values_min_count: Optional[int] = rest_field(name="valuesMinCount") + """The minimum count of the values.""" + + @overload + def __init__( + self, + *, + cardinality: Optional[Union[str, "_models.CardinalityValue"]] = None, + constraints: Optional[List["_models.AtlasConstraintDef"]] = None, + default_value: Optional[str] = None, + description: Optional[str] = None, + include_in_notification: Optional[bool] = None, + is_indexable: Optional[bool] = None, + is_optional: Optional[bool] = None, + is_unique: Optional[bool] = None, + name: Optional[str] = None, + options: Optional[Dict[str, str]] = None, + type_name: Optional[str] = None, + values_max_count: Optional[int] = None, + values_min_count: Optional[int] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasBusinessMetadataDef(_model_base.Model): # pylint: disable=too-many-instance-attributes + """class that captures details of a struct-type. + + :ivar category: The enum of type category. Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", + "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + :vartype category: str or ~azure.purview.datamap.models.TypeCategory + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar date_formatter: The date format. + :vartype date_formatter: ~azure.purview.datamap.models.DateFormat + :ivar description: The description of the type definition. + :vartype description: str + :ivar guid: The GUID of the type definition. + :vartype guid: str + :ivar name: The name of the type definition. + :vartype name: str + :ivar options: The options for the type definition. + :vartype options: dict[str, str] + :ivar service_type: The service type. + :vartype service_type: str + :ivar type_version: The version of the type. + :vartype type_version: str + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar version: The version of the record. + :vartype version: int + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar attribute_defs: An array of attribute definitions. + :vartype attribute_defs: list[~azure.purview.datamap.models.AtlasAttributeDef] + """ + + category: Optional[Union[str, "_models.TypeCategory"]] = rest_field() + """The enum of type category. Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", + \"STRUCT\", \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"MAP\", \"RELATIONSHIP\", and + \"TERM_TEMPLATE\".""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + date_formatter: Optional["_models.DateFormat"] = rest_field(name="dateFormatter") + """The date format.""" + description: Optional[str] = rest_field() + """The description of the type definition.""" + guid: Optional[str] = rest_field() + """The GUID of the type definition.""" + name: Optional[str] = rest_field() + """The name of the type definition.""" + options: Optional[Dict[str, str]] = rest_field() + """The options for the type definition.""" + service_type: Optional[str] = rest_field(name="serviceType") + """The service type.""" + type_version: Optional[str] = rest_field(name="typeVersion") + """The version of the type.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + version: Optional[int] = rest_field() + """The version of the record.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = rest_field(name="attributeDefs") + """An array of attribute definitions.""" + + @overload + def __init__( + self, + *, + category: Optional[Union[str, "_models.TypeCategory"]] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + date_formatter: Optional["_models.DateFormat"] = None, + description: Optional[str] = None, + guid: Optional[str] = None, + name: Optional[str] = None, + options: Optional[Dict[str, str]] = None, + service_type: Optional[str] = None, + type_version: Optional[str] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + version: Optional[int] = None, + last_modified_t_s: Optional[str] = None, + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasClassification(_model_base.Model): + """An instance of a classification; it doesn't have an identity, this object + exists only when associated with an entity. + + :ivar attributes: The attributes of the struct. + :vartype attributes: dict[str, any] + :ivar type_name: The name of the type. + :vartype type_name: str + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar entity_guid: The GUID of the entity. + :vartype entity_guid: str + :ivar entity_status: Status of the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + :vartype entity_status: str or ~azure.purview.datamap.models.EntityStatus + :ivar remove_propagations_on_entity_delete: Determines if propagations will be removed on + entity deletion. + :vartype remove_propagations_on_entity_delete: bool + :ivar validity_periods: An array of time boundaries indicating validity periods. + :vartype validity_periods: list[~azure.purview.datamap.models.TimeBoundary] + """ + + attributes: Optional[Dict[str, Any]] = rest_field() + """The attributes of the struct.""" + type_name: Optional[str] = rest_field(name="typeName") + """The name of the type.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + entity_guid: Optional[str] = rest_field(name="entityGuid") + """The GUID of the entity.""" + entity_status: Optional[Union[str, "_models.EntityStatus"]] = rest_field(name="entityStatus") + """Status of the entity - can be active or deleted. Deleted entities are not + removed. Known values are: \"ACTIVE\" and \"DELETED\".""" + remove_propagations_on_entity_delete: Optional[bool] = rest_field(name="removePropagationsOnEntityDelete") + """Determines if propagations will be removed on entity deletion.""" + validity_periods: Optional[List["_models.TimeBoundary"]] = rest_field(name="validityPeriods") + """An array of time boundaries indicating validity periods.""" + + @overload + def __init__( + self, + *, + attributes: Optional[Dict[str, Any]] = None, + type_name: Optional[str] = None, + last_modified_t_s: Optional[str] = None, + entity_guid: Optional[str] = None, + entity_status: Optional[Union[str, "_models.EntityStatus"]] = None, + remove_propagations_on_entity_delete: Optional[bool] = None, + validity_periods: Optional[List["_models.TimeBoundary"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasClassificationDef(_model_base.Model): # pylint: disable=too-many-instance-attributes + """class that captures details of a classification-type. + + :ivar category: The enum of type category. Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", + "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + :vartype category: str or ~azure.purview.datamap.models.TypeCategory + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar date_formatter: The date format. + :vartype date_formatter: ~azure.purview.datamap.models.DateFormat + :ivar description: The description of the type definition. + :vartype description: str + :ivar guid: The GUID of the type definition. + :vartype guid: str + :ivar name: The name of the type definition. + :vartype name: str + :ivar options: The options for the type definition. + :vartype options: dict[str, str] + :ivar service_type: The service type. + :vartype service_type: str + :ivar type_version: The version of the type. + :vartype type_version: str + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar version: The version of the record. + :vartype version: int + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar attribute_defs: An array of attribute definitions. + :vartype attribute_defs: list[~azure.purview.datamap.models.AtlasAttributeDef] + :ivar entity_types: Specifying a list of entityType names in the classificationDef, ensures + that + classifications can + only be applied to those entityTypes. + + Any subtypes of the entity types inherit the restriction. + + Any classificationDef subtypes inherit the parents entityTypes restrictions. + + Any classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. + + An empty entityTypes list when there are no parent restrictions means there are no + restrictions. + + An empty entityTypes list when there are parent + restrictions means that the subtype picks up the parents + restrictions. + + If a list of entityTypes are supplied, where one inherits + from another, this will be rejected. This should encourage cleaner + classificationsDefs. + :vartype entity_types: list[str] + :ivar sub_types: An array of sub types. + :vartype sub_types: list[str] + :ivar super_types: An array of super types. + :vartype super_types: list[str] + """ + + category: Optional[Union[str, "_models.TypeCategory"]] = rest_field() + """The enum of type category. Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", + \"STRUCT\", \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"MAP\", \"RELATIONSHIP\", and + \"TERM_TEMPLATE\".""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + date_formatter: Optional["_models.DateFormat"] = rest_field(name="dateFormatter") + """The date format.""" + description: Optional[str] = rest_field() + """The description of the type definition.""" + guid: Optional[str] = rest_field() + """The GUID of the type definition.""" + name: Optional[str] = rest_field() + """The name of the type definition.""" + options: Optional[Dict[str, str]] = rest_field() + """The options for the type definition.""" + service_type: Optional[str] = rest_field(name="serviceType") + """The service type.""" + type_version: Optional[str] = rest_field(name="typeVersion") + """The version of the type.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + version: Optional[int] = rest_field() + """The version of the record.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = rest_field(name="attributeDefs") + """An array of attribute definitions.""" + entity_types: Optional[List[str]] = rest_field(name="entityTypes") + """Specifying a list of entityType names in the classificationDef, ensures that + classifications can + only be applied to those entityTypes. + + Any subtypes of the entity types inherit the restriction. + + Any classificationDef subtypes inherit the parents entityTypes restrictions. + + Any classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. + + An empty entityTypes list when there are no parent restrictions means there are no + restrictions. + + An empty entityTypes list when there are parent + restrictions means that the subtype picks up the parents + restrictions. + + If a list of entityTypes are supplied, where one inherits + from another, this will be rejected. This should encourage cleaner + classificationsDefs.""" + sub_types: Optional[List[str]] = rest_field(name="subTypes") + """An array of sub types.""" + super_types: Optional[List[str]] = rest_field(name="superTypes") + """An array of super types.""" + + @overload + def __init__( + self, + *, + category: Optional[Union[str, "_models.TypeCategory"]] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + date_formatter: Optional["_models.DateFormat"] = None, + description: Optional[str] = None, + guid: Optional[str] = None, + name: Optional[str] = None, + options: Optional[Dict[str, str]] = None, + service_type: Optional[str] = None, + type_version: Optional[str] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + version: Optional[int] = None, + last_modified_t_s: Optional[str] = None, + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = None, + entity_types: Optional[List[str]] = None, + sub_types: Optional[List[str]] = None, + super_types: Optional[List[str]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasClassifications(_model_base.Model): + """REST serialization friendly list. + + :ivar list: An array of objects. + :vartype list: list[any] + :ivar page_size: The size of the page. + :vartype page_size: int + :ivar sort_by: The sorted by field. + :vartype sort_by: str + :ivar sort_type: to specify whether the result should be sorted? If yes, whether asc or desc. + Known values are: "NONE", "ASC", and "DESC". + :vartype sort_type: str or ~azure.purview.datamap.models.SortType + :ivar start_index: The start index of the page. + :vartype start_index: int + :ivar total_count: The total count of items. + :vartype total_count: int + """ + + list: Optional[List[Any]] = rest_field() + """An array of objects.""" + page_size: Optional[int] = rest_field(name="pageSize") + """The size of the page.""" + sort_by: Optional[str] = rest_field(name="sortBy") + """The sorted by field.""" + sort_type: Optional[Union[str, "_models.SortType"]] = rest_field(name="sortType") + """to specify whether the result should be sorted? If yes, whether asc or desc. Known values are: + \"NONE\", \"ASC\", and \"DESC\".""" + start_index: Optional[int] = rest_field(name="startIndex") + """The start index of the page.""" + total_count: Optional[int] = rest_field(name="totalCount") + """The total count of items.""" + + @overload + def __init__( + self, + *, + list: Optional[List[Any]] = None, + page_size: Optional[int] = None, + sort_by: Optional[str] = None, + sort_type: Optional[Union[str, "_models.SortType"]] = None, + start_index: Optional[int] = None, + total_count: Optional[int] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasConstraintDef(_model_base.Model): + """class that captures details of a constraint. + + :ivar params: The parameters of the constraint definition. + :vartype params: dict[str, any] + :ivar type: The type of the constraint. + :vartype type: str + """ + + params: Optional[Dict[str, Any]] = rest_field() + """The parameters of the constraint definition.""" + type: Optional[str] = rest_field() + """The type of the constraint.""" + + @overload + def __init__( + self, + *, + params: Optional[Dict[str, Any]] = None, + type: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasEntitiesWithExtInfo(_model_base.Model): + """An instance of an entity along with extended info - like hive_table, + hive_database. + + :ivar referred_entities: The referred entities. + :vartype referred_entities: dict[str, ~azure.purview.datamap.models.AtlasEntity] + :ivar entities: An array of entities. + :vartype entities: list[~azure.purview.datamap.models.AtlasEntity] + """ + + referred_entities: Optional[Dict[str, "_models.AtlasEntity"]] = rest_field(name="referredEntities") + """The referred entities.""" + entities: Optional[List["_models.AtlasEntity"]] = rest_field() + """An array of entities.""" + + @overload + def __init__( + self, + *, + referred_entities: Optional[Dict[str, "_models.AtlasEntity"]] = None, + entities: Optional[List["_models.AtlasEntity"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasEntity(_model_base.Model): # pylint: disable=too-many-instance-attributes + """An instance of an entity - like hive_table, hive_database. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar attributes: The attributes of the struct. + :vartype attributes: dict[str, any] + :ivar type_name: The name of the type. + :vartype type_name: str + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar business_attributes: Business attributes. + :vartype business_attributes: dict[str, any] + :ivar classifications: An array of classifications. + :vartype classifications: list[~azure.purview.datamap.models.AtlasClassification] + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar custom_attributes: Custom Attribute. + :vartype custom_attributes: dict[str, str] + :ivar guid: The GUID of the entity. + :vartype guid: str + :ivar home_id: The home ID of the entity. + :vartype home_id: str + :ivar collection_id: The collection ID of the entity. + :vartype collection_id: str + :ivar is_incomplete: Whether it is a shell entity. + :vartype is_incomplete: bool + :ivar labels: labels. + :vartype labels: list[str] + :ivar meanings: An array of term assignment headers indicating the meanings of the entity. + :vartype meanings: list[~azure.purview.datamap.models.AtlasTermAssignmentHeader] + :ivar provenance_type: Used to record the provenance of an instance of an entity or + relationship. + :vartype provenance_type: int + :ivar proxy: Determines if there's a proxy. + :vartype proxy: bool + :ivar relationship_attributes: The attributes of relationship. + :vartype relationship_attributes: dict[str, any] + :ivar status: Status of the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + :vartype status: str or ~azure.purview.datamap.models.EntityStatus + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar version: The version of the entity. + :vartype version: int + :ivar contacts: The dictionary of contacts for entities. Key could be Expert or Owner. + :vartype contacts: dict[str, list[~azure.purview.datamap.models.ContactInfo]] + """ + + attributes: Optional[Dict[str, Any]] = rest_field() + """The attributes of the struct.""" + type_name: Optional[str] = rest_field(name="typeName") + """The name of the type.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + business_attributes: Optional[Dict[str, Any]] = rest_field(name="businessAttributes") + """Business attributes.""" + classifications: Optional[List["_models.AtlasClassification"]] = rest_field() + """An array of classifications.""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + custom_attributes: Optional[Dict[str, str]] = rest_field(name="customAttributes") + """Custom Attribute.""" + guid: Optional[str] = rest_field() + """The GUID of the entity.""" + home_id: Optional[str] = rest_field(name="homeId") + """The home ID of the entity.""" + collection_id: Optional[str] = rest_field(name="collectionId", visibility=["read"]) + """The collection ID of the entity.""" + is_incomplete: Optional[bool] = rest_field(name="isIncomplete") + """Whether it is a shell entity.""" + labels: Optional[List[str]] = rest_field() + """labels.""" + meanings: Optional[List["_models.AtlasTermAssignmentHeader"]] = rest_field() + """An array of term assignment headers indicating the meanings of the entity.""" + provenance_type: Optional[int] = rest_field(name="provenanceType") + """Used to record the provenance of an instance of an entity or relationship.""" + proxy: Optional[bool] = rest_field() + """Determines if there's a proxy.""" + relationship_attributes: Optional[Dict[str, Any]] = rest_field(name="relationshipAttributes") + """The attributes of relationship.""" + status: Optional[Union[str, "_models.EntityStatus"]] = rest_field() + """Status of the entity - can be active or deleted. Deleted entities are not + removed. Known values are: \"ACTIVE\" and \"DELETED\".""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + version: Optional[int] = rest_field() + """The version of the entity.""" + contacts: Optional[Dict[str, List["_models.ContactInfo"]]] = rest_field() + """The dictionary of contacts for entities. Key could be Expert or Owner.""" + + @overload + def __init__( + self, + *, + attributes: Optional[Dict[str, Any]] = None, + type_name: Optional[str] = None, + last_modified_t_s: Optional[str] = None, + business_attributes: Optional[Dict[str, Any]] = None, + classifications: Optional[List["_models.AtlasClassification"]] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + custom_attributes: Optional[Dict[str, str]] = None, + guid: Optional[str] = None, + home_id: Optional[str] = None, + is_incomplete: Optional[bool] = None, + labels: Optional[List[str]] = None, + meanings: Optional[List["_models.AtlasTermAssignmentHeader"]] = None, + provenance_type: Optional[int] = None, + proxy: Optional[bool] = None, + relationship_attributes: Optional[Dict[str, Any]] = None, + status: Optional[Union[str, "_models.EntityStatus"]] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + version: Optional[int] = None, + contacts: Optional[Dict[str, List["_models.ContactInfo"]]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasEntityDef(_model_base.Model): # pylint: disable=too-many-instance-attributes + """class that captures details of a entity-type. + + :ivar category: The enum of type category. Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", + "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + :vartype category: str or ~azure.purview.datamap.models.TypeCategory + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar date_formatter: The date format. + :vartype date_formatter: ~azure.purview.datamap.models.DateFormat + :ivar description: The description of the type definition. + :vartype description: str + :ivar guid: The GUID of the type definition. + :vartype guid: str + :ivar name: The name of the type definition. + :vartype name: str + :ivar options: The options for the type definition. + :vartype options: dict[str, str] + :ivar service_type: The service type. + :vartype service_type: str + :ivar type_version: The version of the type. + :vartype type_version: str + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar version: The version of the record. + :vartype version: int + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar attribute_defs: An array of attribute definitions. + :vartype attribute_defs: list[~azure.purview.datamap.models.AtlasAttributeDef] + :ivar sub_types: An array of sub types. + :vartype sub_types: list[str] + :ivar super_types: An array of super types. + :vartype super_types: list[str] + :ivar relationship_attribute_defs: An array of relationship attributes. + :vartype relationship_attribute_defs: + list[~azure.purview.datamap.models.AtlasRelationshipAttributeDef] + """ + + category: Optional[Union[str, "_models.TypeCategory"]] = rest_field() + """The enum of type category. Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", + \"STRUCT\", \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"MAP\", \"RELATIONSHIP\", and + \"TERM_TEMPLATE\".""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + date_formatter: Optional["_models.DateFormat"] = rest_field(name="dateFormatter") + """The date format.""" + description: Optional[str] = rest_field() + """The description of the type definition.""" + guid: Optional[str] = rest_field() + """The GUID of the type definition.""" + name: Optional[str] = rest_field() + """The name of the type definition.""" + options: Optional[Dict[str, str]] = rest_field() + """The options for the type definition.""" + service_type: Optional[str] = rest_field(name="serviceType") + """The service type.""" + type_version: Optional[str] = rest_field(name="typeVersion") + """The version of the type.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + version: Optional[int] = rest_field() + """The version of the record.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = rest_field(name="attributeDefs") + """An array of attribute definitions.""" + sub_types: Optional[List[str]] = rest_field(name="subTypes") + """An array of sub types.""" + super_types: Optional[List[str]] = rest_field(name="superTypes") + """An array of super types.""" + relationship_attribute_defs: Optional[List["_models.AtlasRelationshipAttributeDef"]] = rest_field( + name="relationshipAttributeDefs" + ) + """An array of relationship attributes.""" + + @overload + def __init__( + self, + *, + category: Optional[Union[str, "_models.TypeCategory"]] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + date_formatter: Optional["_models.DateFormat"] = None, + description: Optional[str] = None, + guid: Optional[str] = None, + name: Optional[str] = None, + options: Optional[Dict[str, str]] = None, + service_type: Optional[str] = None, + type_version: Optional[str] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + version: Optional[int] = None, + last_modified_t_s: Optional[str] = None, + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = None, + sub_types: Optional[List[str]] = None, + super_types: Optional[List[str]] = None, + relationship_attribute_defs: Optional[List["_models.AtlasRelationshipAttributeDef"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasEntityHeader(_model_base.Model): # pylint: disable=too-many-instance-attributes + """An instance of an entity - like hive_table, hive_database. + + :ivar attributes: The attributes of the struct. + :vartype attributes: dict[str, any] + :ivar type_name: The name of the type. + :vartype type_name: str + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar classification_names: An array of classification names. + :vartype classification_names: list[str] + :ivar classifications: An array of classifications. + :vartype classifications: list[~azure.purview.datamap.models.AtlasClassification] + :ivar display_text: The display text. + :vartype display_text: str + :ivar guid: The GUID of the record. + :vartype guid: str + :ivar is_incomplete: Whether it is a shell entity. + :vartype is_incomplete: bool + :ivar labels: labels. + :vartype labels: list[str] + :ivar meaning_names: An array of meanings. + :vartype meaning_names: list[str] + :ivar meanings: An array of term assignment headers. + :vartype meanings: list[~azure.purview.datamap.models.AtlasTermAssignmentHeader] + :ivar status: Status of the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + :vartype status: str or ~azure.purview.datamap.models.EntityStatus + """ + + attributes: Optional[Dict[str, Any]] = rest_field() + """The attributes of the struct.""" + type_name: Optional[str] = rest_field(name="typeName") + """The name of the type.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + classification_names: Optional[List[str]] = rest_field(name="classificationNames") + """An array of classification names.""" + classifications: Optional[List["_models.AtlasClassification"]] = rest_field() + """An array of classifications.""" + display_text: Optional[str] = rest_field(name="displayText") + """The display text.""" + guid: Optional[str] = rest_field() + """The GUID of the record.""" + is_incomplete: Optional[bool] = rest_field(name="isIncomplete") + """Whether it is a shell entity.""" + labels: Optional[List[str]] = rest_field() + """labels.""" + meaning_names: Optional[List[str]] = rest_field(name="meaningNames") + """An array of meanings.""" + meanings: Optional[List["_models.AtlasTermAssignmentHeader"]] = rest_field() + """An array of term assignment headers.""" + status: Optional[Union[str, "_models.EntityStatus"]] = rest_field() + """Status of the entity - can be active or deleted. Deleted entities are not + removed. Known values are: \"ACTIVE\" and \"DELETED\".""" + + @overload + def __init__( + self, + *, + attributes: Optional[Dict[str, Any]] = None, + type_name: Optional[str] = None, + last_modified_t_s: Optional[str] = None, + classification_names: Optional[List[str]] = None, + classifications: Optional[List["_models.AtlasClassification"]] = None, + display_text: Optional[str] = None, + guid: Optional[str] = None, + is_incomplete: Optional[bool] = None, + labels: Optional[List[str]] = None, + meaning_names: Optional[List[str]] = None, + meanings: Optional[List["_models.AtlasTermAssignmentHeader"]] = None, + status: Optional[Union[str, "_models.EntityStatus"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasEntityHeaders(_model_base.Model): + """An instance of an entity header map. + + :ivar guid_header_map: The description of the guid header map,. + :vartype guid_header_map: dict[str, ~azure.purview.datamap.models.AtlasEntityHeader] + """ + + guid_header_map: Optional[Dict[str, "_models.AtlasEntityHeader"]] = rest_field(name="guidHeaderMap") + """The description of the guid header map,.""" + + @overload + def __init__( + self, + *, + guid_header_map: Optional[Dict[str, "_models.AtlasEntityHeader"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasEntityWithExtInfo(_model_base.Model): + """An instance of an entity along with extended info - like hive_table, + hive_database. + + :ivar referred_entities: The referred entities. + :vartype referred_entities: dict[str, ~azure.purview.datamap.models.AtlasEntity] + :ivar entity: An instance of an entity - like hive_table, hive_database. + :vartype entity: ~azure.purview.datamap.models.AtlasEntity + """ + + referred_entities: Optional[Dict[str, "_models.AtlasEntity"]] = rest_field(name="referredEntities") + """The referred entities.""" + entity: Optional["_models.AtlasEntity"] = rest_field() + """An instance of an entity - like hive_table, hive_database.""" + + @overload + def __init__( + self, + *, + referred_entities: Optional[Dict[str, "_models.AtlasEntity"]] = None, + entity: Optional["_models.AtlasEntity"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasEnumDef(_model_base.Model): # pylint: disable=too-many-instance-attributes + """class that captures details of an enum-type. + + :ivar category: The enum of type category. Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", + "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + :vartype category: str or ~azure.purview.datamap.models.TypeCategory + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar date_formatter: The date format. + :vartype date_formatter: ~azure.purview.datamap.models.DateFormat + :ivar description: The description of the type definition. + :vartype description: str + :ivar guid: The GUID of the type definition. + :vartype guid: str + :ivar name: The name of the type definition. + :vartype name: str + :ivar options: The options for the type definition. + :vartype options: dict[str, str] + :ivar service_type: The service type. + :vartype service_type: str + :ivar type_version: The version of the type. + :vartype type_version: str + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar version: The version of the record. + :vartype version: int + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar default_value: The default value. + :vartype default_value: str + :ivar element_defs: An array of enum element definitions. + :vartype element_defs: list[~azure.purview.datamap.models.AtlasEnumElementDef] + """ + + category: Optional[Union[str, "_models.TypeCategory"]] = rest_field() + """The enum of type category. Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", + \"STRUCT\", \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"MAP\", \"RELATIONSHIP\", and + \"TERM_TEMPLATE\".""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + date_formatter: Optional["_models.DateFormat"] = rest_field(name="dateFormatter") + """The date format.""" + description: Optional[str] = rest_field() + """The description of the type definition.""" + guid: Optional[str] = rest_field() + """The GUID of the type definition.""" + name: Optional[str] = rest_field() + """The name of the type definition.""" + options: Optional[Dict[str, str]] = rest_field() + """The options for the type definition.""" + service_type: Optional[str] = rest_field(name="serviceType") + """The service type.""" + type_version: Optional[str] = rest_field(name="typeVersion") + """The version of the type.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + version: Optional[int] = rest_field() + """The version of the record.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + default_value: Optional[str] = rest_field(name="defaultValue") + """The default value.""" + element_defs: Optional[List["_models.AtlasEnumElementDef"]] = rest_field(name="elementDefs") + """An array of enum element definitions.""" + + @overload + def __init__( + self, + *, + category: Optional[Union[str, "_models.TypeCategory"]] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + date_formatter: Optional["_models.DateFormat"] = None, + description: Optional[str] = None, + guid: Optional[str] = None, + name: Optional[str] = None, + options: Optional[Dict[str, str]] = None, + service_type: Optional[str] = None, + type_version: Optional[str] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + version: Optional[int] = None, + last_modified_t_s: Optional[str] = None, + default_value: Optional[str] = None, + element_defs: Optional[List["_models.AtlasEnumElementDef"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasEnumElementDef(_model_base.Model): + """class that captures details of an enum-element. + + :ivar description: The description of the enum element definition. + :vartype description: str + :ivar ordinal: The ordinal of the enum element definition. + :vartype ordinal: int + :ivar value: The value of the enum element definition. + :vartype value: str + """ + + description: Optional[str] = rest_field() + """The description of the enum element definition.""" + ordinal: Optional[int] = rest_field() + """The ordinal of the enum element definition.""" + value: Optional[str] = rest_field() + """The value of the enum element definition.""" + + @overload + def __init__( + self, + *, + description: Optional[str] = None, + ordinal: Optional[int] = None, + value: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasErrorResponse(_model_base.Model): + """An error response from the service. + + :ivar request_id: The request ID. + :vartype request_id: str + :ivar error_code: The error code. + :vartype error_code: str + :ivar error_message: The error message. + :vartype error_message: str + """ + + request_id: Optional[str] = rest_field(name="requestId") + """The request ID.""" + error_code: Optional[str] = rest_field(name="errorCode") + """The error code.""" + error_message: Optional[str] = rest_field(name="errorMessage") + """The error message.""" + + @overload + def __init__( + self, + *, + request_id: Optional[str] = None, + error_code: Optional[str] = None, + error_message: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasGlossary(_model_base.Model): # pylint: disable=too-many-instance-attributes + """The glossary object. + + :ivar guid: The GUID of the object. + :vartype guid: str + :ivar classifications: An array of classifications. + :vartype classifications: list[~azure.purview.datamap.models.AtlasClassification] + :ivar long_description: The long version description. + :vartype long_description: str + :ivar name: The name of the glossary object. + :vartype name: str + :ivar qualified_name: The qualified name of the glossary object. + :vartype qualified_name: str + :ivar short_description: The short version of description. + :vartype short_description: str + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar categories: An array of categories. + :vartype categories: list[~azure.purview.datamap.models.AtlasRelatedCategoryHeader] + :ivar language: The language of the glossary. + :vartype language: str + :ivar terms: An array of related term headers. + :vartype terms: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar usage: The usage of the glossary. + :vartype usage: str + """ + + guid: Optional[str] = rest_field() + """The GUID of the object.""" + classifications: Optional[List["_models.AtlasClassification"]] = rest_field() + """An array of classifications.""" + long_description: Optional[str] = rest_field(name="longDescription") + """The long version description.""" + name: Optional[str] = rest_field() + """The name of the glossary object.""" + qualified_name: Optional[str] = rest_field(name="qualifiedName") + """The qualified name of the glossary object.""" + short_description: Optional[str] = rest_field(name="shortDescription") + """The short version of description.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + categories: Optional[List["_models.AtlasRelatedCategoryHeader"]] = rest_field() + """An array of categories.""" + language: Optional[str] = rest_field() + """The language of the glossary.""" + terms: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field() + """An array of related term headers.""" + usage: Optional[str] = rest_field() + """The usage of the glossary.""" + + @overload + def __init__( + self, + *, + guid: Optional[str] = None, + classifications: Optional[List["_models.AtlasClassification"]] = None, + long_description: Optional[str] = None, + name: Optional[str] = None, + qualified_name: Optional[str] = None, + short_description: Optional[str] = None, + last_modified_t_s: Optional[str] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + categories: Optional[List["_models.AtlasRelatedCategoryHeader"]] = None, + language: Optional[str] = None, + terms: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + usage: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasGlossaryCategory(_model_base.Model): # pylint: disable=too-many-instance-attributes + """The glossary category. + + :ivar guid: The GUID of the object. + :vartype guid: str + :ivar classifications: An array of classifications. + :vartype classifications: list[~azure.purview.datamap.models.AtlasClassification] + :ivar long_description: The long version description. + :vartype long_description: str + :ivar name: The name of the glossary object. + :vartype name: str + :ivar qualified_name: The qualified name of the glossary object. + :vartype qualified_name: str + :ivar short_description: The short version of description. + :vartype short_description: str + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar anchor: The glossary header with basic information. + :vartype anchor: ~azure.purview.datamap.models.AtlasGlossaryHeader + :ivar children_categories: An array of children categories. + :vartype children_categories: list[~azure.purview.datamap.models.AtlasRelatedCategoryHeader] + :ivar parent_category: The header of the related category. + :vartype parent_category: ~azure.purview.datamap.models.AtlasRelatedCategoryHeader + :ivar terms: An array of related term headers. + :vartype terms: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + """ + + guid: Optional[str] = rest_field() + """The GUID of the object.""" + classifications: Optional[List["_models.AtlasClassification"]] = rest_field() + """An array of classifications.""" + long_description: Optional[str] = rest_field(name="longDescription") + """The long version description.""" + name: Optional[str] = rest_field() + """The name of the glossary object.""" + qualified_name: Optional[str] = rest_field(name="qualifiedName") + """The qualified name of the glossary object.""" + short_description: Optional[str] = rest_field(name="shortDescription") + """The short version of description.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + anchor: Optional["_models.AtlasGlossaryHeader"] = rest_field() + """The glossary header with basic information.""" + children_categories: Optional[List["_models.AtlasRelatedCategoryHeader"]] = rest_field(name="childrenCategories") + """An array of children categories.""" + parent_category: Optional["_models.AtlasRelatedCategoryHeader"] = rest_field(name="parentCategory") + """The header of the related category.""" + terms: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field() + """An array of related term headers.""" + + @overload + def __init__( + self, + *, + guid: Optional[str] = None, + classifications: Optional[List["_models.AtlasClassification"]] = None, + long_description: Optional[str] = None, + name: Optional[str] = None, + qualified_name: Optional[str] = None, + short_description: Optional[str] = None, + last_modified_t_s: Optional[str] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + anchor: Optional["_models.AtlasGlossaryHeader"] = None, + children_categories: Optional[List["_models.AtlasRelatedCategoryHeader"]] = None, + parent_category: Optional["_models.AtlasRelatedCategoryHeader"] = None, + terms: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasGlossaryExtInfo(_model_base.Model): # pylint: disable=too-many-instance-attributes + """The extended information of glossary. + + :ivar guid: The GUID of the object. + :vartype guid: str + :ivar classifications: An array of classifications. + :vartype classifications: list[~azure.purview.datamap.models.AtlasClassification] + :ivar long_description: The long version description. + :vartype long_description: str + :ivar name: The name of the glossary object. + :vartype name: str + :ivar qualified_name: The qualified name of the glossary object. + :vartype qualified_name: str + :ivar short_description: The short version of description. + :vartype short_description: str + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar categories: An array of categories. + :vartype categories: list[~azure.purview.datamap.models.AtlasRelatedCategoryHeader] + :ivar language: The language of the glossary. + :vartype language: str + :ivar terms: An array of related term headers. + :vartype terms: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar usage: The usage of the glossary. + :vartype usage: str + :ivar category_info: The glossary category information. + :vartype category_info: dict[str, ~azure.purview.datamap.models.AtlasGlossaryCategory] + :ivar term_info: The glossary term information. + :vartype term_info: dict[str, ~azure.purview.datamap.models.AtlasGlossaryTerm] + """ + + guid: Optional[str] = rest_field() + """The GUID of the object.""" + classifications: Optional[List["_models.AtlasClassification"]] = rest_field() + """An array of classifications.""" + long_description: Optional[str] = rest_field(name="longDescription") + """The long version description.""" + name: Optional[str] = rest_field() + """The name of the glossary object.""" + qualified_name: Optional[str] = rest_field(name="qualifiedName") + """The qualified name of the glossary object.""" + short_description: Optional[str] = rest_field(name="shortDescription") + """The short version of description.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + categories: Optional[List["_models.AtlasRelatedCategoryHeader"]] = rest_field() + """An array of categories.""" + language: Optional[str] = rest_field() + """The language of the glossary.""" + terms: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field() + """An array of related term headers.""" + usage: Optional[str] = rest_field() + """The usage of the glossary.""" + category_info: Optional[Dict[str, "_models.AtlasGlossaryCategory"]] = rest_field(name="categoryInfo") + """The glossary category information.""" + term_info: Optional[Dict[str, "_models.AtlasGlossaryTerm"]] = rest_field(name="termInfo") + """The glossary term information.""" + + @overload + def __init__( + self, + *, + guid: Optional[str] = None, + classifications: Optional[List["_models.AtlasClassification"]] = None, + long_description: Optional[str] = None, + name: Optional[str] = None, + qualified_name: Optional[str] = None, + short_description: Optional[str] = None, + last_modified_t_s: Optional[str] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + categories: Optional[List["_models.AtlasRelatedCategoryHeader"]] = None, + language: Optional[str] = None, + terms: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + usage: Optional[str] = None, + category_info: Optional[Dict[str, "_models.AtlasGlossaryCategory"]] = None, + term_info: Optional[Dict[str, "_models.AtlasGlossaryTerm"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasGlossaryHeader(_model_base.Model): + """The glossary header with basic information. + + :ivar display_text: The display text. + :vartype display_text: str + :ivar glossary_guid: The GUID of the glossary. + :vartype glossary_guid: str + :ivar relation_guid: The GUID of the relationship. + :vartype relation_guid: str + """ + + display_text: Optional[str] = rest_field(name="displayText") + """The display text.""" + glossary_guid: Optional[str] = rest_field(name="glossaryGuid") + """The GUID of the glossary.""" + relation_guid: Optional[str] = rest_field(name="relationGuid") + """The GUID of the relationship.""" + + @overload + def __init__( + self, + *, + display_text: Optional[str] = None, + glossary_guid: Optional[str] = None, + relation_guid: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasGlossaryTerm(_model_base.Model): # pylint: disable=too-many-instance-attributes + """The glossary term. + + :ivar guid: The GUID of the object. + :vartype guid: str + :ivar classifications: An array of classifications. + :vartype classifications: list[~azure.purview.datamap.models.AtlasClassification] + :ivar long_description: The long version description. + :vartype long_description: str + :ivar name: The name of the glossary object. + :vartype name: str + :ivar qualified_name: The qualified name of the glossary object. + :vartype qualified_name: str + :ivar short_description: The short version of description. + :vartype short_description: str + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar abbreviation: The abbreviation of the term. + :vartype abbreviation: str + :ivar template_name: The name of the template. + :vartype template_name: list[any] + :ivar anchor: The glossary header with basic information. + :vartype anchor: ~azure.purview.datamap.models.AtlasGlossaryHeader + :ivar antonyms: An array of related term headers as antonyms. + :vartype antonyms: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar status: Status of the AtlasGlossaryTerm. Known values are: "Draft", "Approved", "Alert", + and "Expired". + :vartype status: str or ~azure.purview.datamap.models.TermStatus + :ivar nick_name: The nick name of the term. + :vartype nick_name: str + :ivar hierarchy_info: The hierarchy information of the term. + :vartype hierarchy_info: list[~azure.purview.datamap.models.PurviewObjectId] + :ivar resources: An array of resource link for term. + :vartype resources: list[~azure.purview.datamap.models.ResourceLink] + :ivar contacts: The dictionary of contacts for terms. Key could be Expert or Steward. + :vartype contacts: dict[str, list[~azure.purview.datamap.models.ContactInfo]] + :ivar attributes: The custom attributes of the term, which is map>. + The + key of the first layer map is term template name. + :vartype attributes: dict[str, dict[str, any]] + :ivar assigned_entities: An array of related object IDs. + :vartype assigned_entities: list[~azure.purview.datamap.models.AtlasRelatedObjectId] + :ivar categories: An array of term categorization headers. + :vartype categories: list[~azure.purview.datamap.models.AtlasTermCategorizationHeader] + :ivar classifies: An array of related term headers. + :vartype classifies: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar examples: An array of examples. + :vartype examples: list[str] + :ivar is_a: An array of related term headers indicating the is-a relationship. + :vartype is_a: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar preferred_terms: An array of preferred related term headers. + :vartype preferred_terms: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar preferred_to_terms: An array of related term headers that are preferred to. + :vartype preferred_to_terms: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar replaced_by: An array of related term headers that are replaced by. + :vartype replaced_by: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar replacement_terms: An array of related term headers for replacement. + :vartype replacement_terms: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar see_also: An array of related term headers for see also. + :vartype see_also: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar synonyms: An array of related term headers as synonyms. + :vartype synonyms: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar translated_terms: An array of translated related term headers. + :vartype translated_terms: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar translation_terms: An array of related term headers for translation. + :vartype translation_terms: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar usage: The usage of the term. + :vartype usage: str + :ivar valid_values: An array of related term headers as valid values. + :vartype valid_values: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :ivar valid_values_for: An array of related term headers as valid values for other records. + :vartype valid_values_for: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + """ + + guid: Optional[str] = rest_field() + """The GUID of the object.""" + classifications: Optional[List["_models.AtlasClassification"]] = rest_field() + """An array of classifications.""" + long_description: Optional[str] = rest_field(name="longDescription") + """The long version description.""" + name: Optional[str] = rest_field() + """The name of the glossary object.""" + qualified_name: Optional[str] = rest_field(name="qualifiedName") + """The qualified name of the glossary object.""" + short_description: Optional[str] = rest_field(name="shortDescription") + """The short version of description.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + abbreviation: Optional[str] = rest_field() + """The abbreviation of the term.""" + template_name: Optional[List[Any]] = rest_field(name="templateName") + """The name of the template.""" + anchor: Optional["_models.AtlasGlossaryHeader"] = rest_field() + """The glossary header with basic information.""" + antonyms: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field() + """An array of related term headers as antonyms.""" + status: Optional[Union[str, "_models.TermStatus"]] = rest_field() + """Status of the AtlasGlossaryTerm. Known values are: \"Draft\", \"Approved\", \"Alert\", and + \"Expired\".""" + nick_name: Optional[str] = rest_field(name="nickName") + """The nick name of the term.""" + hierarchy_info: Optional[List["_models.PurviewObjectId"]] = rest_field(name="hierarchyInfo") + """The hierarchy information of the term.""" + resources: Optional[List["_models.ResourceLink"]] = rest_field() + """An array of resource link for term.""" + contacts: Optional[Dict[str, List["_models.ContactInfo"]]] = rest_field() + """The dictionary of contacts for terms. Key could be Expert or Steward.""" + attributes: Optional[Dict[str, Dict[str, Any]]] = rest_field() + """The custom attributes of the term, which is map>. + The + key of the first layer map is term template name.""" + assigned_entities: Optional[List["_models.AtlasRelatedObjectId"]] = rest_field(name="assignedEntities") + """An array of related object IDs.""" + categories: Optional[List["_models.AtlasTermCategorizationHeader"]] = rest_field() + """An array of term categorization headers.""" + classifies: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field() + """An array of related term headers.""" + examples: Optional[List[str]] = rest_field() + """An array of examples.""" + is_a: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field(name="isA") + """An array of related term headers indicating the is-a relationship.""" + preferred_terms: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field(name="preferredTerms") + """An array of preferred related term headers.""" + preferred_to_terms: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field(name="preferredToTerms") + """An array of related term headers that are preferred to.""" + replaced_by: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field(name="replacedBy") + """An array of related term headers that are replaced by.""" + replacement_terms: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field(name="replacementTerms") + """An array of related term headers for replacement.""" + see_also: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field(name="seeAlso") + """An array of related term headers for see also.""" + synonyms: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field() + """An array of related term headers as synonyms.""" + translated_terms: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field(name="translatedTerms") + """An array of translated related term headers.""" + translation_terms: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field(name="translationTerms") + """An array of related term headers for translation.""" + usage: Optional[str] = rest_field() + """The usage of the term.""" + valid_values: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field(name="validValues") + """An array of related term headers as valid values.""" + valid_values_for: Optional[List["_models.AtlasRelatedTermHeader"]] = rest_field(name="validValuesFor") + """An array of related term headers as valid values for other records.""" + + @overload + def __init__( + self, + *, + guid: Optional[str] = None, + classifications: Optional[List["_models.AtlasClassification"]] = None, + long_description: Optional[str] = None, + name: Optional[str] = None, + qualified_name: Optional[str] = None, + short_description: Optional[str] = None, + last_modified_t_s: Optional[str] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + abbreviation: Optional[str] = None, + template_name: Optional[List[Any]] = None, + anchor: Optional["_models.AtlasGlossaryHeader"] = None, + antonyms: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + status: Optional[Union[str, "_models.TermStatus"]] = None, + nick_name: Optional[str] = None, + hierarchy_info: Optional[List["_models.PurviewObjectId"]] = None, + resources: Optional[List["_models.ResourceLink"]] = None, + contacts: Optional[Dict[str, List["_models.ContactInfo"]]] = None, + attributes: Optional[Dict[str, Dict[str, Any]]] = None, + assigned_entities: Optional[List["_models.AtlasRelatedObjectId"]] = None, + categories: Optional[List["_models.AtlasTermCategorizationHeader"]] = None, + classifies: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + examples: Optional[List[str]] = None, + is_a: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + preferred_terms: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + preferred_to_terms: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + replaced_by: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + replacement_terms: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + see_also: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + synonyms: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + translated_terms: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + translation_terms: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + usage: Optional[str] = None, + valid_values: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + valid_values_for: Optional[List["_models.AtlasRelatedTermHeader"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasLineageInfo(_model_base.Model): + """The lineage information. + + :ivar base_entity_guid: The GUID of the base entity. + :vartype base_entity_guid: str + :ivar guid_entity_map: The GUID entity map. + :vartype guid_entity_map: dict[str, ~azure.purview.datamap.models.AtlasEntityHeader] + :ivar width_counts: The entity count in specific direction. + :vartype width_counts: dict[str, dict[str, any]] + :ivar lineage_depth: The depth of lineage. + :vartype lineage_depth: int + :ivar lineage_width: The width of lineage. + :vartype lineage_width: int + :ivar children_count: The number of children node. + :vartype children_count: int + :ivar lineage_direction: The enum of lineage direction. Known values are: "INPUT", "OUTPUT", + and "BOTH". + :vartype lineage_direction: str or ~azure.purview.datamap.models.LineageDirection + :ivar parent_relations: An array of parentRelations relations. + :vartype parent_relations: list[~azure.purview.datamap.models.ParentRelation] + :ivar relations: An array of lineage relations. + :vartype relations: list[~azure.purview.datamap.models.LineageRelation] + """ + + base_entity_guid: Optional[str] = rest_field(name="baseEntityGuid") + """The GUID of the base entity.""" + guid_entity_map: Optional[Dict[str, "_models.AtlasEntityHeader"]] = rest_field(name="guidEntityMap") + """The GUID entity map.""" + width_counts: Optional[Dict[str, Dict[str, Any]]] = rest_field(name="widthCounts") + """The entity count in specific direction.""" + lineage_depth: Optional[int] = rest_field(name="lineageDepth") + """The depth of lineage.""" + lineage_width: Optional[int] = rest_field(name="lineageWidth") + """The width of lineage.""" + children_count: Optional[int] = rest_field(name="childrenCount") + """The number of children node.""" + lineage_direction: Optional[Union[str, "_models.LineageDirection"]] = rest_field(name="lineageDirection") + """The enum of lineage direction. Known values are: \"INPUT\", \"OUTPUT\", and \"BOTH\".""" + parent_relations: Optional[List["_models.ParentRelation"]] = rest_field(name="parentRelations") + """An array of parentRelations relations.""" + relations: Optional[List["_models.LineageRelation"]] = rest_field() + """An array of lineage relations.""" + + @overload + def __init__( + self, + *, + base_entity_guid: Optional[str] = None, + guid_entity_map: Optional[Dict[str, "_models.AtlasEntityHeader"]] = None, + width_counts: Optional[Dict[str, Dict[str, Any]]] = None, + lineage_depth: Optional[int] = None, + lineage_width: Optional[int] = None, + children_count: Optional[int] = None, + lineage_direction: Optional[Union[str, "_models.LineageDirection"]] = None, + parent_relations: Optional[List["_models.ParentRelation"]] = None, + relations: Optional[List["_models.LineageRelation"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasObjectId(_model_base.Model): + """Reference to an object-instance of a type - like entity. + + :ivar guid: The GUID of the object. + :vartype guid: str + :ivar type_name: The name of the type. + :vartype type_name: str + :ivar unique_attributes: The unique attributes of the object. + :vartype unique_attributes: dict[str, any] + """ + + guid: Optional[str] = rest_field() + """The GUID of the object.""" + type_name: Optional[str] = rest_field(name="typeName") + """The name of the type.""" + unique_attributes: Optional[Dict[str, Any]] = rest_field(name="uniqueAttributes") + """The unique attributes of the object.""" + + @overload + def __init__( + self, + *, + guid: Optional[str] = None, + type_name: Optional[str] = None, + unique_attributes: Optional[Dict[str, Any]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasRelatedCategoryHeader(_model_base.Model): + """The header of the related category. + + :ivar category_guid: The GUID of the category. + :vartype category_guid: str + :ivar description: The description of the category header. + :vartype description: str + :ivar display_text: The display text. + :vartype display_text: str + :ivar parent_category_guid: The GUID of the parent category. + :vartype parent_category_guid: str + :ivar relation_guid: The GUID of the relationship. + :vartype relation_guid: str + """ + + category_guid: Optional[str] = rest_field(name="categoryGuid") + """The GUID of the category.""" + description: Optional[str] = rest_field() + """The description of the category header.""" + display_text: Optional[str] = rest_field(name="displayText") + """The display text.""" + parent_category_guid: Optional[str] = rest_field(name="parentCategoryGuid") + """The GUID of the parent category.""" + relation_guid: Optional[str] = rest_field(name="relationGuid") + """The GUID of the relationship.""" + + @overload + def __init__( + self, + *, + category_guid: Optional[str] = None, + description: Optional[str] = None, + display_text: Optional[str] = None, + parent_category_guid: Optional[str] = None, + relation_guid: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasRelatedObjectId(_model_base.Model): + """Reference to an object-instance of AtlasEntity type used in relationship + attribute values. + + :ivar guid: The GUID of the object. + :vartype guid: str + :ivar type_name: The name of the type. + :vartype type_name: str + :ivar unique_attributes: The unique attributes of the object. + :vartype unique_attributes: dict[str, any] + :ivar display_text: The display text. + :vartype display_text: str + :ivar entity_status: Status of the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + :vartype entity_status: str or ~azure.purview.datamap.models.EntityStatus + :ivar relationship_type: Relationship type. + :vartype relationship_type: str + :ivar relationship_attributes: Captures details of struct contents. Not instantiated directly, + used only via + AtlasEntity, AtlasClassification. + :vartype relationship_attributes: ~azure.purview.datamap.models.AtlasStruct + :ivar relationship_guid: The GUID of the relationship. + :vartype relationship_guid: str + :ivar relationship_status: The enum of relationship status. Known values are: "ACTIVE" and + "DELETED". + :vartype relationship_status: str or ~azure.purview.datamap.models.StatusAtlasRelationship + """ + + guid: Optional[str] = rest_field() + """The GUID of the object.""" + type_name: Optional[str] = rest_field(name="typeName") + """The name of the type.""" + unique_attributes: Optional[Dict[str, Any]] = rest_field(name="uniqueAttributes") + """The unique attributes of the object.""" + display_text: Optional[str] = rest_field(name="displayText") + """The display text.""" + entity_status: Optional[Union[str, "_models.EntityStatus"]] = rest_field(name="entityStatus") + """Status of the entity - can be active or deleted. Deleted entities are not + removed. Known values are: \"ACTIVE\" and \"DELETED\".""" + relationship_type: Optional[str] = rest_field(name="relationshipType") + """Relationship type.""" + relationship_attributes: Optional["_models.AtlasStruct"] = rest_field(name="relationshipAttributes") + """Captures details of struct contents. Not instantiated directly, used only via + AtlasEntity, AtlasClassification.""" + relationship_guid: Optional[str] = rest_field(name="relationshipGuid") + """The GUID of the relationship.""" + relationship_status: Optional[Union[str, "_models.StatusAtlasRelationship"]] = rest_field(name="relationshipStatus") + """The enum of relationship status. Known values are: \"ACTIVE\" and \"DELETED\".""" + + @overload + def __init__( + self, + *, + guid: Optional[str] = None, + type_name: Optional[str] = None, + unique_attributes: Optional[Dict[str, Any]] = None, + display_text: Optional[str] = None, + entity_status: Optional[Union[str, "_models.EntityStatus"]] = None, + relationship_type: Optional[str] = None, + relationship_attributes: Optional["_models.AtlasStruct"] = None, + relationship_guid: Optional[str] = None, + relationship_status: Optional[Union[str, "_models.StatusAtlasRelationship"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasRelatedTermHeader(_model_base.Model): + """The header of the related term. + + :ivar description: The description of the related term. + :vartype description: str + :ivar display_text: The display text. + :vartype display_text: str + :ivar expression: The expression of the term. + :vartype expression: str + :ivar relation_guid: The GUID of the relationship. + :vartype relation_guid: str + :ivar status: The status of term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + :vartype status: str or ~azure.purview.datamap.models.AtlasTermRelationshipStatus + :ivar steward: The steward of the term. + :vartype steward: str + :ivar term_guid: The GUID of the term. + :vartype term_guid: str + """ + + description: Optional[str] = rest_field() + """The description of the related term.""" + display_text: Optional[str] = rest_field(name="displayText") + """The display text.""" + expression: Optional[str] = rest_field() + """The expression of the term.""" + relation_guid: Optional[str] = rest_field(name="relationGuid") + """The GUID of the relationship.""" + status: Optional[Union[str, "_models.AtlasTermRelationshipStatus"]] = rest_field() + """The status of term relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", + \"OBSOLETE\", and \"OTHER\".""" + steward: Optional[str] = rest_field() + """The steward of the term.""" + term_guid: Optional[str] = rest_field(name="termGuid") + """The GUID of the term.""" + + @overload + def __init__( + self, + *, + description: Optional[str] = None, + display_text: Optional[str] = None, + expression: Optional[str] = None, + relation_guid: Optional[str] = None, + status: Optional[Union[str, "_models.AtlasTermRelationshipStatus"]] = None, + steward: Optional[str] = None, + term_guid: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasRelationship(_model_base.Model): # pylint: disable=too-many-instance-attributes + """Atlas relationship instance. + + :ivar attributes: The attributes of the struct. + :vartype attributes: dict[str, any] + :ivar type_name: The name of the type. + :vartype type_name: str + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar end1: Reference to an object-instance of a type - like entity. + :vartype end1: ~azure.purview.datamap.models.AtlasObjectId + :ivar end2: Reference to an object-instance of a type - like entity. + :vartype end2: ~azure.purview.datamap.models.AtlasObjectId + :ivar guid: The GUID of the relationship. + :vartype guid: str + :ivar home_id: The home ID of the relationship. + :vartype home_id: str + :ivar label: The label of the relationship. + :vartype label: str + :ivar provenance_type: Used to record the provenance of an instance of an entity or + relationship. + :vartype provenance_type: int + :ivar status: The enum of relationship status. Known values are: "ACTIVE" and "DELETED". + :vartype status: str or ~azure.purview.datamap.models.StatusAtlasRelationship + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar version: The version of the relationship. + :vartype version: int + """ + + attributes: Optional[Dict[str, Any]] = rest_field() + """The attributes of the struct.""" + type_name: Optional[str] = rest_field(name="typeName") + """The name of the type.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + end1: Optional["_models.AtlasObjectId"] = rest_field() + """Reference to an object-instance of a type - like entity.""" + end2: Optional["_models.AtlasObjectId"] = rest_field() + """Reference to an object-instance of a type - like entity.""" + guid: Optional[str] = rest_field() + """The GUID of the relationship.""" + home_id: Optional[str] = rest_field(name="homeId") + """The home ID of the relationship.""" + label: Optional[str] = rest_field() + """The label of the relationship.""" + provenance_type: Optional[int] = rest_field(name="provenanceType") + """Used to record the provenance of an instance of an entity or relationship.""" + status: Optional[Union[str, "_models.StatusAtlasRelationship"]] = rest_field() + """The enum of relationship status. Known values are: \"ACTIVE\" and \"DELETED\".""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + version: Optional[int] = rest_field() + """The version of the relationship.""" + + @overload + def __init__( + self, + *, + attributes: Optional[Dict[str, Any]] = None, + type_name: Optional[str] = None, + last_modified_t_s: Optional[str] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + end1: Optional["_models.AtlasObjectId"] = None, + end2: Optional["_models.AtlasObjectId"] = None, + guid: Optional[str] = None, + home_id: Optional[str] = None, + label: Optional[str] = None, + provenance_type: Optional[int] = None, + status: Optional[Union[str, "_models.StatusAtlasRelationship"]] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + version: Optional[int] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasRelationshipAttributeDef(_model_base.Model): # pylint: disable=too-many-instance-attributes + """The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship. + + :ivar cardinality: single-valued attribute or multi-valued attribute. Known values are: + "SINGLE", "LIST", and "SET". + :vartype cardinality: str or ~azure.purview.datamap.models.CardinalityValue + :ivar constraints: An array of constraints. + :vartype constraints: list[~azure.purview.datamap.models.AtlasConstraintDef] + :ivar default_value: The default value of the attribute. + :vartype default_value: str + :ivar description: The description of the attribute. + :vartype description: str + :ivar include_in_notification: Determines if it is included in notification. + :vartype include_in_notification: bool + :ivar is_indexable: Determines if it is indexable. + :vartype is_indexable: bool + :ivar is_optional: Determines if it is optional. + :vartype is_optional: bool + :ivar is_unique: Determines if it unique. + :vartype is_unique: bool + :ivar name: The name of the attribute. + :vartype name: str + :ivar options: The options for the attribute. + :vartype options: dict[str, str] + :ivar type_name: The name of the type. + :vartype type_name: str + :ivar values_max_count: The maximum count of the values. + :vartype values_max_count: int + :ivar values_min_count: The minimum count of the values. + :vartype values_min_count: int + :ivar is_legacy_attribute: Determines if it is a legacy attribute. + :vartype is_legacy_attribute: bool + :ivar relationship_type_name: The name of the relationship type. + :vartype relationship_type_name: str + """ + + cardinality: Optional[Union[str, "_models.CardinalityValue"]] = rest_field() + """single-valued attribute or multi-valued attribute. Known values are: \"SINGLE\", \"LIST\", and + \"SET\".""" + constraints: Optional[List["_models.AtlasConstraintDef"]] = rest_field() + """An array of constraints.""" + default_value: Optional[str] = rest_field(name="defaultValue") + """The default value of the attribute.""" + description: Optional[str] = rest_field() + """The description of the attribute.""" + include_in_notification: Optional[bool] = rest_field(name="includeInNotification") + """Determines if it is included in notification.""" + is_indexable: Optional[bool] = rest_field(name="isIndexable") + """Determines if it is indexable.""" + is_optional: Optional[bool] = rest_field(name="isOptional") + """Determines if it is optional.""" + is_unique: Optional[bool] = rest_field(name="isUnique") + """Determines if it unique.""" + name: Optional[str] = rest_field() + """The name of the attribute.""" + options: Optional[Dict[str, str]] = rest_field() + """The options for the attribute.""" + type_name: Optional[str] = rest_field(name="typeName") + """The name of the type.""" + values_max_count: Optional[int] = rest_field(name="valuesMaxCount") + """The maximum count of the values.""" + values_min_count: Optional[int] = rest_field(name="valuesMinCount") + """The minimum count of the values.""" + is_legacy_attribute: Optional[bool] = rest_field(name="isLegacyAttribute") + """Determines if it is a legacy attribute.""" + relationship_type_name: Optional[str] = rest_field(name="relationshipTypeName") + """The name of the relationship type.""" + + @overload + def __init__( + self, + *, + cardinality: Optional[Union[str, "_models.CardinalityValue"]] = None, + constraints: Optional[List["_models.AtlasConstraintDef"]] = None, + default_value: Optional[str] = None, + description: Optional[str] = None, + include_in_notification: Optional[bool] = None, + is_indexable: Optional[bool] = None, + is_optional: Optional[bool] = None, + is_unique: Optional[bool] = None, + name: Optional[str] = None, + options: Optional[Dict[str, str]] = None, + type_name: Optional[str] = None, + values_max_count: Optional[int] = None, + values_min_count: Optional[int] = None, + is_legacy_attribute: Optional[bool] = None, + relationship_type_name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasRelationshipDef(_model_base.Model): # pylint: disable=too-many-instance-attributes + """AtlasRelationshipDef is a TypeDef that defines a relationship. + As with other typeDefs the AtlasRelationshipDef has a name. Once created the + RelationshipDef has a guid. + The name and the guid are the 2 ways that the + RelationshipDef is identified. + RelationshipDefs have 2 ends, each of which + specify cardinality, an EntityDef type name and name and optionally + whether the + end is a container. + RelationshipDefs can have AttributeDefs - though only + primitive types are allowed. + RelationshipDefs have a relationshipCategory + specifying the UML type of relationship required + The way EntityDefs and + RelationshipDefs are intended to be used is that EntityDefs will define + AttributeDefs these AttributeDefs + will not specify an EntityDef type name as + their types. + RelationshipDefs introduce new attributes to the entity + instances. For example + EntityDef A might have attributes attr1,attr2,attr3 + + EntityDef B might have attributes attr4,attr5,attr6 + RelationshipDef + AtoB might define 2 ends + + end1: type A, name attr7 + end2: type B, name attr8 + + When an instance of EntityDef A is created, it + will have attributes attr1,attr2,attr3,attr7 + When an instance of EntityDef + B is created, it will have attributes attr4,attr5,attr6,attr8 + + In this way + relationshipDefs can be authored separately from entityDefs and can inject + relationship attributes into + the entity instances. + + :ivar category: The enum of type category. Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", + "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + :vartype category: str or ~azure.purview.datamap.models.TypeCategory + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar date_formatter: The date format. + :vartype date_formatter: ~azure.purview.datamap.models.DateFormat + :ivar description: The description of the type definition. + :vartype description: str + :ivar guid: The GUID of the type definition. + :vartype guid: str + :ivar name: The name of the type definition. + :vartype name: str + :ivar options: The options for the type definition. + :vartype options: dict[str, str] + :ivar service_type: The service type. + :vartype service_type: str + :ivar type_version: The version of the type. + :vartype type_version: str + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar version: The version of the record. + :vartype version: int + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar attribute_defs: An array of attribute definitions. + :vartype attribute_defs: list[~azure.purview.datamap.models.AtlasAttributeDef] + :ivar end_def1: The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship. + :vartype end_def1: ~azure.purview.datamap.models.AtlasRelationshipEndDef + :ivar end_def2: The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship. + :vartype end_def2: ~azure.purview.datamap.models.AtlasRelationshipEndDef + :ivar relationship_category: The Relationship category determines the style of relationship + around + containment and lifecycle. + UML terminology is used for the values. + ASSOCIATION is a relationship with no containment. + COMPOSITION and AGGREGATION are containment relationships. + The difference being in the lifecycles of the container and its children. + In the COMPOSITION case, the children cannot exist without the container. + For AGGREGATION, the life cycles of the container and children are totally independent. Known + values are: "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + :vartype relationship_category: str or ~azure.purview.datamap.models.RelationshipCategory + :ivar relationship_label: The label of the relationship. + :vartype relationship_label: str + """ + + category: Optional[Union[str, "_models.TypeCategory"]] = rest_field() + """The enum of type category. Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", + \"STRUCT\", \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"MAP\", \"RELATIONSHIP\", and + \"TERM_TEMPLATE\".""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + date_formatter: Optional["_models.DateFormat"] = rest_field(name="dateFormatter") + """The date format.""" + description: Optional[str] = rest_field() + """The description of the type definition.""" + guid: Optional[str] = rest_field() + """The GUID of the type definition.""" + name: Optional[str] = rest_field() + """The name of the type definition.""" + options: Optional[Dict[str, str]] = rest_field() + """The options for the type definition.""" + service_type: Optional[str] = rest_field(name="serviceType") + """The service type.""" + type_version: Optional[str] = rest_field(name="typeVersion") + """The version of the type.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + version: Optional[int] = rest_field() + """The version of the record.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = rest_field(name="attributeDefs") + """An array of attribute definitions.""" + end_def1: Optional["_models.AtlasRelationshipEndDef"] = rest_field(name="endDef1") + """The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship.""" + end_def2: Optional["_models.AtlasRelationshipEndDef"] = rest_field(name="endDef2") + """The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship.""" + relationship_category: Optional[Union[str, "_models.RelationshipCategory"]] = rest_field( + name="relationshipCategory" + ) + """The Relationship category determines the style of relationship around + containment and lifecycle. + UML terminology is used for the values. + ASSOCIATION is a relationship with no containment. + COMPOSITION and AGGREGATION are containment relationships. + The difference being in the lifecycles of the container and its children. + In the COMPOSITION case, the children cannot exist without the container. + For AGGREGATION, the life cycles of the container and children are totally independent. Known + values are: \"ASSOCIATION\", \"AGGREGATION\", and \"COMPOSITION\".""" + relationship_label: Optional[str] = rest_field(name="relationshipLabel") + """The label of the relationship.""" + + @overload + def __init__( + self, + *, + category: Optional[Union[str, "_models.TypeCategory"]] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + date_formatter: Optional["_models.DateFormat"] = None, + description: Optional[str] = None, + guid: Optional[str] = None, + name: Optional[str] = None, + options: Optional[Dict[str, str]] = None, + service_type: Optional[str] = None, + type_version: Optional[str] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + version: Optional[int] = None, + last_modified_t_s: Optional[str] = None, + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = None, + end_def1: Optional["_models.AtlasRelationshipEndDef"] = None, + end_def2: Optional["_models.AtlasRelationshipEndDef"] = None, + relationship_category: Optional[Union[str, "_models.RelationshipCategory"]] = None, + relationship_label: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasRelationshipEndDef(_model_base.Model): + """The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship. + + :ivar cardinality: single-valued attribute or multi-valued attribute. Known values are: + "SINGLE", "LIST", and "SET". + :vartype cardinality: str or ~azure.purview.datamap.models.CardinalityValue + :ivar description: The description of the relationship end definition. + :vartype description: str + :ivar is_container: Determines if it is container. + :vartype is_container: bool + :ivar is_legacy_attribute: Determines if it is a legacy attribute. + :vartype is_legacy_attribute: bool + :ivar name: The name of the relationship end definition. + :vartype name: str + :ivar type: The type of the relationship end. + :vartype type: str + """ + + cardinality: Optional[Union[str, "_models.CardinalityValue"]] = rest_field() + """single-valued attribute or multi-valued attribute. Known values are: \"SINGLE\", \"LIST\", and + \"SET\".""" + description: Optional[str] = rest_field() + """The description of the relationship end definition.""" + is_container: Optional[bool] = rest_field(name="isContainer") + """Determines if it is container.""" + is_legacy_attribute: Optional[bool] = rest_field(name="isLegacyAttribute") + """Determines if it is a legacy attribute.""" + name: Optional[str] = rest_field() + """The name of the relationship end definition.""" + type: Optional[str] = rest_field() + """The type of the relationship end.""" + + @overload + def __init__( + self, + *, + cardinality: Optional[Union[str, "_models.CardinalityValue"]] = None, + description: Optional[str] = None, + is_container: Optional[bool] = None, + is_legacy_attribute: Optional[bool] = None, + name: Optional[str] = None, + type: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasRelationshipWithExtInfo(_model_base.Model): + """The relationship with extended information. + + :ivar referred_entities: The referred entity header. + :vartype referred_entities: dict[str, ~azure.purview.datamap.models.AtlasEntityHeader] + :ivar relationship: Atlas relationship instance. + :vartype relationship: ~azure.purview.datamap.models.AtlasRelationship + """ + + referred_entities: Optional[Dict[str, "_models.AtlasEntityHeader"]] = rest_field(name="referredEntities") + """The referred entity header.""" + relationship: Optional["_models.AtlasRelationship"] = rest_field() + """Atlas relationship instance.""" + + @overload + def __init__( + self, + *, + referred_entities: Optional[Dict[str, "_models.AtlasEntityHeader"]] = None, + relationship: Optional["_models.AtlasRelationship"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasStruct(_model_base.Model): + """Captures details of struct contents. Not instantiated directly, used only via + AtlasEntity, AtlasClassification. + + :ivar attributes: The attributes of the struct. + :vartype attributes: dict[str, any] + :ivar type_name: The name of the type. + :vartype type_name: str + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + """ + + attributes: Optional[Dict[str, Any]] = rest_field() + """The attributes of the struct.""" + type_name: Optional[str] = rest_field(name="typeName") + """The name of the type.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + + @overload + def __init__( + self, + *, + attributes: Optional[Dict[str, Any]] = None, + type_name: Optional[str] = None, + last_modified_t_s: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasStructDef(_model_base.Model): # pylint: disable=too-many-instance-attributes + """class that captures details of a struct-type. + + :ivar category: The enum of type category. Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", + "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + :vartype category: str or ~azure.purview.datamap.models.TypeCategory + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar date_formatter: The date format. + :vartype date_formatter: ~azure.purview.datamap.models.DateFormat + :ivar description: The description of the type definition. + :vartype description: str + :ivar guid: The GUID of the type definition. + :vartype guid: str + :ivar name: The name of the type definition. + :vartype name: str + :ivar options: The options for the type definition. + :vartype options: dict[str, str] + :ivar service_type: The service type. + :vartype service_type: str + :ivar type_version: The version of the type. + :vartype type_version: str + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar version: The version of the record. + :vartype version: int + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar attribute_defs: An array of attribute definitions. + :vartype attribute_defs: list[~azure.purview.datamap.models.AtlasAttributeDef] + """ + + category: Optional[Union[str, "_models.TypeCategory"]] = rest_field() + """The enum of type category. Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", + \"STRUCT\", \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"MAP\", \"RELATIONSHIP\", and + \"TERM_TEMPLATE\".""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + date_formatter: Optional["_models.DateFormat"] = rest_field(name="dateFormatter") + """The date format.""" + description: Optional[str] = rest_field() + """The description of the type definition.""" + guid: Optional[str] = rest_field() + """The GUID of the type definition.""" + name: Optional[str] = rest_field() + """The name of the type definition.""" + options: Optional[Dict[str, str]] = rest_field() + """The options for the type definition.""" + service_type: Optional[str] = rest_field(name="serviceType") + """The service type.""" + type_version: Optional[str] = rest_field(name="typeVersion") + """The version of the type.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + version: Optional[int] = rest_field() + """The version of the record.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = rest_field(name="attributeDefs") + """An array of attribute definitions.""" + + @overload + def __init__( + self, + *, + category: Optional[Union[str, "_models.TypeCategory"]] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + date_formatter: Optional["_models.DateFormat"] = None, + description: Optional[str] = None, + guid: Optional[str] = None, + name: Optional[str] = None, + options: Optional[Dict[str, str]] = None, + service_type: Optional[str] = None, + type_version: Optional[str] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + version: Optional[int] = None, + last_modified_t_s: Optional[str] = None, + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasTermAssignmentHeader(_model_base.Model): + """The header for term assignment. + + :ivar confidence: The confidence of the term assignment. + :vartype confidence: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar description: The description of the term assignment. + :vartype description: str + :ivar display_text: The display text. + :vartype display_text: str + :ivar expression: The expression of the term assignment. + :vartype expression: str + :ivar relation_guid: The GUID of the relationship. + :vartype relation_guid: str + :ivar status: The status of terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + :vartype status: str or ~azure.purview.datamap.models.AtlasTermAssignmentStatus + :ivar steward: The steward of the term. + :vartype steward: str + :ivar term_guid: The GUID of the term. + :vartype term_guid: str + """ + + confidence: Optional[int] = rest_field() + """The confidence of the term assignment.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + description: Optional[str] = rest_field() + """The description of the term assignment.""" + display_text: Optional[str] = rest_field(name="displayText") + """The display text.""" + expression: Optional[str] = rest_field() + """The expression of the term assignment.""" + relation_guid: Optional[str] = rest_field(name="relationGuid") + """The GUID of the relationship.""" + status: Optional[Union[str, "_models.AtlasTermAssignmentStatus"]] = rest_field() + """The status of terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\", + \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\", and \"OTHER\".""" + steward: Optional[str] = rest_field() + """The steward of the term.""" + term_guid: Optional[str] = rest_field(name="termGuid") + """The GUID of the term.""" + + @overload + def __init__( + self, + *, + confidence: Optional[int] = None, + created_by: Optional[str] = None, + description: Optional[str] = None, + display_text: Optional[str] = None, + expression: Optional[str] = None, + relation_guid: Optional[str] = None, + status: Optional[Union[str, "_models.AtlasTermAssignmentStatus"]] = None, + steward: Optional[str] = None, + term_guid: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasTermCategorizationHeader(_model_base.Model): + """The basic information for term categorization. + + :ivar category_guid: The GUID of the category. + :vartype category_guid: str + :ivar description: The description of the record. + :vartype description: str + :ivar display_text: The display text. + :vartype display_text: str + :ivar relation_guid: The GUID of the relationship. + :vartype relation_guid: str + :ivar status: The status of term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + :vartype status: str or ~azure.purview.datamap.models.AtlasTermRelationshipStatus + """ + + category_guid: Optional[str] = rest_field(name="categoryGuid") + """The GUID of the category.""" + description: Optional[str] = rest_field() + """The description of the record.""" + display_text: Optional[str] = rest_field(name="displayText") + """The display text.""" + relation_guid: Optional[str] = rest_field(name="relationGuid") + """The GUID of the relationship.""" + status: Optional[Union[str, "_models.AtlasTermRelationshipStatus"]] = rest_field() + """The status of term relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", + \"OBSOLETE\", and \"OTHER\".""" + + @overload + def __init__( + self, + *, + category_guid: Optional[str] = None, + description: Optional[str] = None, + display_text: Optional[str] = None, + relation_guid: Optional[str] = None, + status: Optional[Union[str, "_models.AtlasTermRelationshipStatus"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasTypeDef(_model_base.Model): # pylint: disable=too-many-instance-attributes + """The definitions of type. + + :ivar category: The enum of type category. Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", + "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + :vartype category: str or ~azure.purview.datamap.models.TypeCategory + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar date_formatter: The date format. + :vartype date_formatter: ~azure.purview.datamap.models.DateFormat + :ivar description: The description of the type definition. + :vartype description: str + :ivar guid: The GUID of the type definition. + :vartype guid: str + :ivar name: The name of the type definition. + :vartype name: str + :ivar options: The options for the type definition. + :vartype options: dict[str, str] + :ivar service_type: The service type. + :vartype service_type: str + :ivar type_version: The version of the type. + :vartype type_version: str + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar version: The version of the record. + :vartype version: int + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar entity_types: Specifying a list of entityType names in the classificationDef, ensures + that + classifications can + only be applied to those entityTypes. + + Any subtypes of the entity types inherit the restriction. + + Any classificationDef subtypes inherit the parents entityTypes restrictions. + + Any classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. + + An empty entityTypes list when there are no parent restrictions means there are no + restrictions. + + An empty entityTypes list when there are parent + restrictions means that the subtype picks up the parents + restrictions. + + If a list of entityTypes are supplied, where one inherits + from another, this will be rejected. This should encourage cleaner + classificationsDefs. + :vartype entity_types: list[str] + :ivar sub_types: An array of sub types. + :vartype sub_types: list[str] + :ivar super_types: An array of super types. + :vartype super_types: list[str] + :ivar relationship_attribute_defs: An array of relationship attributes. + :vartype relationship_attribute_defs: + list[~azure.purview.datamap.models.AtlasRelationshipAttributeDef] + :ivar default_value: The default value. + :vartype default_value: str + :ivar element_defs: An array of enum element definitions. + :vartype element_defs: list[~azure.purview.datamap.models.AtlasEnumElementDef] + :ivar end_def1: The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship. + :vartype end_def1: ~azure.purview.datamap.models.AtlasRelationshipEndDef + :ivar end_def2: The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship. + :vartype end_def2: ~azure.purview.datamap.models.AtlasRelationshipEndDef + :ivar relationship_category: The Relationship category determines the style of relationship + around + containment and lifecycle. + UML terminology is used for the values. + + ASSOCIATION is a relationship with no containment. + COMPOSITION and AGGREGATION are containment relationships. + + The difference being in the lifecycles of the container and its children. + In the COMPOSITION case, the children cannot exist without the container. + For AGGREGATION, the life cycles of the container and children are totally independent. Known + values are: "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + :vartype relationship_category: str or ~azure.purview.datamap.models.RelationshipCategory + :ivar relationship_label: The label of the relationship. + :vartype relationship_label: str + :ivar attribute_defs: An array of attribute definitions. + :vartype attribute_defs: list[~azure.purview.datamap.models.AtlasAttributeDef] + """ + + category: Optional[Union[str, "_models.TypeCategory"]] = rest_field() + """The enum of type category. Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", + \"STRUCT\", \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"MAP\", \"RELATIONSHIP\", and + \"TERM_TEMPLATE\".""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + date_formatter: Optional["_models.DateFormat"] = rest_field(name="dateFormatter") + """The date format.""" + description: Optional[str] = rest_field() + """The description of the type definition.""" + guid: Optional[str] = rest_field() + """The GUID of the type definition.""" + name: Optional[str] = rest_field() + """The name of the type definition.""" + options: Optional[Dict[str, str]] = rest_field() + """The options for the type definition.""" + service_type: Optional[str] = rest_field(name="serviceType") + """The service type.""" + type_version: Optional[str] = rest_field(name="typeVersion") + """The version of the type.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + version: Optional[int] = rest_field() + """The version of the record.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + entity_types: Optional[List[str]] = rest_field(name="entityTypes") + """Specifying a list of entityType names in the classificationDef, ensures that + classifications can + only be applied to those entityTypes. + + Any subtypes of the entity types inherit the restriction. + + Any classificationDef subtypes inherit the parents entityTypes restrictions. + + Any classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. + + An empty entityTypes list when there are no parent restrictions means there are no + restrictions. + + An empty entityTypes list when there are parent + restrictions means that the subtype picks up the parents + restrictions. + + If a list of entityTypes are supplied, where one inherits + from another, this will be rejected. This should encourage cleaner + classificationsDefs.""" + sub_types: Optional[List[str]] = rest_field(name="subTypes") + """An array of sub types.""" + super_types: Optional[List[str]] = rest_field(name="superTypes") + """An array of super types.""" + relationship_attribute_defs: Optional[List["_models.AtlasRelationshipAttributeDef"]] = rest_field( + name="relationshipAttributeDefs" + ) + """An array of relationship attributes.""" + default_value: Optional[str] = rest_field(name="defaultValue") + """The default value.""" + element_defs: Optional[List["_models.AtlasEnumElementDef"]] = rest_field(name="elementDefs") + """An array of enum element definitions.""" + end_def1: Optional["_models.AtlasRelationshipEndDef"] = rest_field(name="endDef1") + """The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship.""" + end_def2: Optional["_models.AtlasRelationshipEndDef"] = rest_field(name="endDef2") + """The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship.""" + relationship_category: Optional[Union[str, "_models.RelationshipCategory"]] = rest_field( + name="relationshipCategory" + ) + """The Relationship category determines the style of relationship around + containment and lifecycle. + UML terminology is used for the values. + + ASSOCIATION is a relationship with no containment. + COMPOSITION and AGGREGATION are containment relationships. + + The difference being in the lifecycles of the container and its children. + In the COMPOSITION case, the children cannot exist without the container. + For AGGREGATION, the life cycles of the container and children are totally independent. Known + values are: \"ASSOCIATION\", \"AGGREGATION\", and \"COMPOSITION\".""" + relationship_label: Optional[str] = rest_field(name="relationshipLabel") + """The label of the relationship.""" + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = rest_field(name="attributeDefs") + """An array of attribute definitions.""" + + @overload + def __init__( + self, + *, + category: Optional[Union[str, "_models.TypeCategory"]] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + date_formatter: Optional["_models.DateFormat"] = None, + description: Optional[str] = None, + guid: Optional[str] = None, + name: Optional[str] = None, + options: Optional[Dict[str, str]] = None, + service_type: Optional[str] = None, + type_version: Optional[str] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + version: Optional[int] = None, + last_modified_t_s: Optional[str] = None, + entity_types: Optional[List[str]] = None, + sub_types: Optional[List[str]] = None, + super_types: Optional[List[str]] = None, + relationship_attribute_defs: Optional[List["_models.AtlasRelationshipAttributeDef"]] = None, + default_value: Optional[str] = None, + element_defs: Optional[List["_models.AtlasEnumElementDef"]] = None, + end_def1: Optional["_models.AtlasRelationshipEndDef"] = None, + end_def2: Optional["_models.AtlasRelationshipEndDef"] = None, + relationship_category: Optional[Union[str, "_models.RelationshipCategory"]] = None, + relationship_label: Optional[str] = None, + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasTypeDefHeader(_model_base.Model): + """The basic information of the type definition. + + :ivar category: The enum of type category. Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", + "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + :vartype category: str or ~azure.purview.datamap.models.TypeCategory + :ivar guid: The GUID of the type definition. + :vartype guid: str + :ivar name: The name of the type definition. + :vartype name: str + """ + + category: Optional[Union[str, "_models.TypeCategory"]] = rest_field() + """The enum of type category. Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", + \"STRUCT\", \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"MAP\", \"RELATIONSHIP\", and + \"TERM_TEMPLATE\".""" + guid: Optional[str] = rest_field() + """The GUID of the type definition.""" + name: Optional[str] = rest_field() + """The name of the type definition.""" + + @overload + def __init__( + self, + *, + category: Optional[Union[str, "_models.TypeCategory"]] = None, + guid: Optional[str] = None, + name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AtlasTypesDef(_model_base.Model): + """The definitions of types. + + :ivar business_metadata_defs: businessMetadataDefs. + :vartype business_metadata_defs: list[~azure.purview.datamap.models.AtlasBusinessMetadataDef] + :ivar classification_defs: An array of classification definitions. + :vartype classification_defs: list[~azure.purview.datamap.models.AtlasClassificationDef] + :ivar entity_defs: An array of entity definitions. + :vartype entity_defs: list[~azure.purview.datamap.models.AtlasEntityDef] + :ivar enum_defs: An array of enum definitions. + :vartype enum_defs: list[~azure.purview.datamap.models.AtlasEnumDef] + :ivar relationship_defs: An array of relationship definitions. + :vartype relationship_defs: list[~azure.purview.datamap.models.AtlasRelationshipDef] + :ivar struct_defs: An array of struct definitions. + :vartype struct_defs: list[~azure.purview.datamap.models.AtlasStructDef] + :ivar term_template_defs: An array of term template definitions. + :vartype term_template_defs: list[~azure.purview.datamap.models.TermTemplateDef] + """ + + business_metadata_defs: Optional[List["_models.AtlasBusinessMetadataDef"]] = rest_field(name="businessMetadataDefs") + """businessMetadataDefs.""" + classification_defs: Optional[List["_models.AtlasClassificationDef"]] = rest_field(name="classificationDefs") + """An array of classification definitions.""" + entity_defs: Optional[List["_models.AtlasEntityDef"]] = rest_field(name="entityDefs") + """An array of entity definitions.""" + enum_defs: Optional[List["_models.AtlasEnumDef"]] = rest_field(name="enumDefs") + """An array of enum definitions.""" + relationship_defs: Optional[List["_models.AtlasRelationshipDef"]] = rest_field(name="relationshipDefs") + """An array of relationship definitions.""" + struct_defs: Optional[List["_models.AtlasStructDef"]] = rest_field(name="structDefs") + """An array of struct definitions.""" + term_template_defs: Optional[List["_models.TermTemplateDef"]] = rest_field(name="termTemplateDefs") + """An array of term template definitions.""" + + @overload + def __init__( + self, + *, + business_metadata_defs: Optional[List["_models.AtlasBusinessMetadataDef"]] = None, + classification_defs: Optional[List["_models.AtlasClassificationDef"]] = None, + entity_defs: Optional[List["_models.AtlasEntityDef"]] = None, + enum_defs: Optional[List["_models.AtlasEnumDef"]] = None, + relationship_defs: Optional[List["_models.AtlasRelationshipDef"]] = None, + struct_defs: Optional[List["_models.AtlasStructDef"]] = None, + term_template_defs: Optional[List["_models.TermTemplateDef"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AutoCompleteOptions(_model_base.Model): + """The payload of autocomplete request. + + :ivar keywords: The keywords applied to all fields that support autocomplete operation. It must + be at least 1 character, and no more than 100 characters. + :vartype keywords: str + :ivar limit: The number of autocomplete results we hope to return. The default value is 50. + The value must be a number between 1 and 100. + :vartype limit: int + :ivar filter: The filter for the autocomplete request. + :vartype filter: any + """ + + keywords: Optional[str] = rest_field() + """The keywords applied to all fields that support autocomplete operation. It must + be at least 1 character, and no more than 100 characters.""" + limit: Optional[int] = rest_field() + """The number of autocomplete results we hope to return. The default value is 50. + The value must be a number between 1 and 100.""" + filter: Optional[Any] = rest_field() + """The filter for the autocomplete request.""" + + @overload + def __init__( + self, + *, + keywords: Optional[str] = None, + limit: Optional[int] = None, + filter: Optional[Any] = None, # pylint: disable=redefined-builtin + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AutoCompleteResult(_model_base.Model): + """The result of the autocomplete request. + + :ivar value: The result value. + :vartype value: list[~azure.purview.datamap.models.AutoCompleteResultValue] + """ + + value: Optional[List["_models.AutoCompleteResultValue"]] = rest_field() + """The result value.""" + + @overload + def __init__( + self, + *, + value: Optional[List["_models.AutoCompleteResultValue"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AutoCompleteResultValue(_model_base.Model): + """The value item of the autocomplete suggest. + + :ivar text: The completed term or phrase. + :vartype text: str + :ivar query_plus_text: The completed search query text. + :vartype query_plus_text: str + """ + + text: Optional[str] = rest_field() + """The completed term or phrase.""" + query_plus_text: Optional[str] = rest_field(name="queryPlusText") + """The completed search query text.""" + + @overload + def __init__( + self, + *, + text: Optional[str] = None, + query_plus_text: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class BulkImportResult(_model_base.Model): + """Bulk import result. + + :ivar failed_import_info_list: failed importInfoList. + :vartype failed_import_info_list: list[~azure.purview.datamap.models.ImportInfo] + :ivar success_import_info_list: successful importInfoList. + :vartype success_import_info_list: list[~azure.purview.datamap.models.ImportInfo] + """ + + failed_import_info_list: Optional[List["_models.ImportInfo"]] = rest_field(name="failedImportInfoList") + """failed importInfoList.""" + success_import_info_list: Optional[List["_models.ImportInfo"]] = rest_field(name="successImportInfoList") + """successful importInfoList.""" + + @overload + def __init__( + self, + *, + failed_import_info_list: Optional[List["_models.ImportInfo"]] = None, + success_import_info_list: Optional[List["_models.ImportInfo"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ClassificationAssociateOptions(_model_base.Model): + """The request payload for classification association. + + :ivar classification: An instance of a classification; it doesn't have an identity, this object + exists only when associated with an entity. + :vartype classification: ~azure.purview.datamap.models.AtlasClassification + :ivar entity_guids: The GUID of the entity. + :vartype entity_guids: list[str] + """ + + classification: Optional["_models.AtlasClassification"] = rest_field() + """An instance of a classification; it doesn't have an identity, this object + exists only when associated with an entity.""" + entity_guids: Optional[List[str]] = rest_field(name="entityGuids") + """The GUID of the entity.""" + + @overload + def __init__( + self, + *, + classification: Optional["_models.AtlasClassification"] = None, + entity_guids: Optional[List[str]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ContactInfo(_model_base.Model): + """ContactInfo. + + :ivar id: Azure Active Directory object Id. + :vartype id: str + :ivar info: additional information to describe this contact. + :vartype info: str + """ + + id: Optional[str] = rest_field() + """Azure Active Directory object Id.""" + info: Optional[str] = rest_field() + """additional information to describe this contact.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + info: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ContactSearchResultValue(_model_base.Model): + """The contact in the search and suggest result. + + :ivar id: The GUID of the contact. + :vartype id: str + :ivar info: The description of the contact. + :vartype info: str + :ivar contact_type: The type of the contact. It can be Expert or Owner for an entity. It can be + Expert or Steward for a glossary term. + :vartype contact_type: str + """ + + id: Optional[str] = rest_field() + """The GUID of the contact.""" + info: Optional[str] = rest_field() + """The description of the contact.""" + contact_type: Optional[str] = rest_field(name="contactType") + """The type of the contact. It can be Expert or Owner for an entity. It can be + Expert or Steward for a glossary term.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + info: Optional[str] = None, + contact_type: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DateFormat(_model_base.Model): + """The date format. + + :ivar available_locales: An array of available locales. + :vartype available_locales: list[str] + :ivar calendar: Calendar. + :vartype calendar: float + :ivar date_instance: The date format. + :vartype date_instance: ~azure.purview.datamap.models.DateFormat + :ivar date_time_instance: The date format. + :vartype date_time_instance: ~azure.purview.datamap.models.DateFormat + :ivar instance: The date format. + :vartype instance: ~azure.purview.datamap.models.DateFormat + :ivar lenient: Determines the leniency of the date format. + :vartype lenient: bool + :ivar number_format: The number format. + :vartype number_format: ~azure.purview.datamap.models.NumberFormat + :ivar time_instance: The date format. + :vartype time_instance: ~azure.purview.datamap.models.DateFormat + :ivar time_zone: The timezone information. + :vartype time_zone: ~azure.purview.datamap.models.TimeZone + """ + + available_locales: Optional[List[str]] = rest_field(name="availableLocales") + """An array of available locales.""" + calendar: Optional[float] = rest_field() + """Calendar.""" + date_instance: Optional["_models.DateFormat"] = rest_field(name="dateInstance") + """The date format.""" + date_time_instance: Optional["_models.DateFormat"] = rest_field(name="dateTimeInstance") + """The date format.""" + instance: Optional["_models.DateFormat"] = rest_field() + """The date format.""" + lenient: Optional[bool] = rest_field() + """Determines the leniency of the date format.""" + number_format: Optional["_models.NumberFormat"] = rest_field(name="numberFormat") + """The number format.""" + time_instance: Optional["_models.DateFormat"] = rest_field(name="timeInstance") + """The date format.""" + time_zone: Optional["_models.TimeZone"] = rest_field(name="timeZone") + """The timezone information.""" + + @overload + def __init__( + self, + *, + available_locales: Optional[List[str]] = None, + calendar: Optional[float] = None, + date_instance: Optional["_models.DateFormat"] = None, + date_time_instance: Optional["_models.DateFormat"] = None, + instance: Optional["_models.DateFormat"] = None, + lenient: Optional[bool] = None, + number_format: Optional["_models.NumberFormat"] = None, + time_instance: Optional["_models.DateFormat"] = None, + time_zone: Optional["_models.TimeZone"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class EntityMutationResult(_model_base.Model): + """The mutation response result of entity. + + :ivar guid_assignments: A map of GUID assignments with entities. + :vartype guid_assignments: dict[str, str] + :ivar mutated_entities: The entity headers of mutated entities. + :vartype mutated_entities: dict[str, list[~azure.purview.datamap.models.AtlasEntityHeader]] + :ivar partial_updated_entities: An array of entity headers that partially updated. + :vartype partial_updated_entities: list[~azure.purview.datamap.models.AtlasEntityHeader] + """ + + guid_assignments: Optional[Dict[str, str]] = rest_field(name="guidAssignments") + """A map of GUID assignments with entities.""" + mutated_entities: Optional[Dict[str, List["_models.AtlasEntityHeader"]]] = rest_field(name="mutatedEntities") + """The entity headers of mutated entities.""" + partial_updated_entities: Optional[List["_models.AtlasEntityHeader"]] = rest_field(name="partialUpdatedEntities") + """An array of entity headers that partially updated.""" + + @overload + def __init__( + self, + *, + guid_assignments: Optional[Dict[str, str]] = None, + mutated_entities: Optional[Dict[str, List["_models.AtlasEntityHeader"]]] = None, + partial_updated_entities: Optional[List["_models.AtlasEntityHeader"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ImportInfo(_model_base.Model): + """ImportInfo. + + :ivar child_object_name: childObjectName. + :vartype child_object_name: str + :ivar import_status: importStatus. Known values are: "SUCCESS" and "FAILED". + :vartype import_status: str or ~azure.purview.datamap.models.ImportStatus + :ivar parent_object_name: parentObjectName. + :vartype parent_object_name: str + :ivar remarks: remarks. + :vartype remarks: str + """ + + child_object_name: Optional[str] = rest_field(name="childObjectName") + """childObjectName.""" + import_status: Optional[Union[str, "_models.ImportStatus"]] = rest_field(name="importStatus") + """importStatus. Known values are: \"SUCCESS\" and \"FAILED\".""" + parent_object_name: Optional[str] = rest_field(name="parentObjectName") + """parentObjectName.""" + remarks: Optional[str] = rest_field() + """remarks.""" + + @overload + def __init__( + self, + *, + child_object_name: Optional[str] = None, + import_status: Optional[Union[str, "_models.ImportStatus"]] = None, + parent_object_name: Optional[str] = None, + remarks: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class LineageRelation(_model_base.Model): + """The lineage relation with GUID of the from and to entity. + + :ivar from_entity_id: The GUID of from-entity. + :vartype from_entity_id: str + :ivar relationship_id: The GUID of relationship. + :vartype relationship_id: str + :ivar to_entity_id: The GUID of to-entity. + :vartype to_entity_id: str + """ + + from_entity_id: Optional[str] = rest_field(name="fromEntityId") + """The GUID of from-entity.""" + relationship_id: Optional[str] = rest_field(name="relationshipId") + """The GUID of relationship.""" + to_entity_id: Optional[str] = rest_field(name="toEntityId") + """The GUID of to-entity.""" + + @overload + def __init__( + self, + *, + from_entity_id: Optional[str] = None, + relationship_id: Optional[str] = None, + to_entity_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MoveEntitiesOptions(_model_base.Model): + """MoveEntitiesOptions. + + :ivar entity_guids: An array of entity guids to be moved to target collection. + :vartype entity_guids: list[str] + """ + + entity_guids: Optional[List[str]] = rest_field(name="entityGuids") + """An array of entity guids to be moved to target collection.""" + + @overload + def __init__( + self, + *, + entity_guids: Optional[List[str]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class NumberFormat(_model_base.Model): # pylint: disable=too-many-instance-attributes + """The number format. + + :ivar available_locales: The number format. + :vartype available_locales: list[str] + :ivar currency: The currency. + :vartype currency: str + :ivar currency_instance: The number format. + :vartype currency_instance: ~azure.purview.datamap.models.NumberFormat + :ivar grouping_used: Determines if grouping is used. + :vartype grouping_used: bool + :ivar instance: The number format. + :vartype instance: ~azure.purview.datamap.models.NumberFormat + :ivar integer_instance: The number format. + :vartype integer_instance: ~azure.purview.datamap.models.NumberFormat + :ivar maximum_fraction_digits: The maximum of fraction digits. + :vartype maximum_fraction_digits: int + :ivar maximum_integer_digits: The maximum of integer digits. + :vartype maximum_integer_digits: int + :ivar minimum_fraction_digits: The minimum of fraction digits. + :vartype minimum_fraction_digits: int + :ivar minimum_integer_digits: The minimum of integer digits. + :vartype minimum_integer_digits: int + :ivar number_instance: The number format. + :vartype number_instance: ~azure.purview.datamap.models.NumberFormat + :ivar parse_integer_only: Determines if only integer is parsed. + :vartype parse_integer_only: bool + :ivar percent_instance: The number format. + :vartype percent_instance: ~azure.purview.datamap.models.NumberFormat + :ivar rounding_mode: The enum of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + :vartype rounding_mode: str or ~azure.purview.datamap.models.RoundingMode + """ + + available_locales: Optional[List[str]] = rest_field(name="availableLocales") + """The number format.""" + currency: Optional[str] = rest_field() + """The currency.""" + currency_instance: Optional["_models.NumberFormat"] = rest_field(name="currencyInstance") + """The number format.""" + grouping_used: Optional[bool] = rest_field(name="groupingUsed") + """Determines if grouping is used.""" + instance: Optional["_models.NumberFormat"] = rest_field() + """The number format.""" + integer_instance: Optional["_models.NumberFormat"] = rest_field(name="integerInstance") + """The number format.""" + maximum_fraction_digits: Optional[int] = rest_field(name="maximumFractionDigits") + """The maximum of fraction digits.""" + maximum_integer_digits: Optional[int] = rest_field(name="maximumIntegerDigits") + """The maximum of integer digits.""" + minimum_fraction_digits: Optional[int] = rest_field(name="minimumFractionDigits") + """The minimum of fraction digits.""" + minimum_integer_digits: Optional[int] = rest_field(name="minimumIntegerDigits") + """The minimum of integer digits.""" + number_instance: Optional["_models.NumberFormat"] = rest_field(name="numberInstance") + """The number format.""" + parse_integer_only: Optional[bool] = rest_field(name="parseIntegerOnly") + """Determines if only integer is parsed.""" + percent_instance: Optional["_models.NumberFormat"] = rest_field(name="percentInstance") + """The number format.""" + rounding_mode: Optional[Union[str, "_models.RoundingMode"]] = rest_field(name="roundingMode") + """The enum of rounding mode. Known values are: \"UP\", \"DOWN\", \"CEILING\", \"FLOOR\", + \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", and \"UNNECESSARY\".""" + + @overload + def __init__( + self, + *, + available_locales: Optional[List[str]] = None, + currency: Optional[str] = None, + currency_instance: Optional["_models.NumberFormat"] = None, + grouping_used: Optional[bool] = None, + instance: Optional["_models.NumberFormat"] = None, + integer_instance: Optional["_models.NumberFormat"] = None, + maximum_fraction_digits: Optional[int] = None, + maximum_integer_digits: Optional[int] = None, + minimum_fraction_digits: Optional[int] = None, + minimum_integer_digits: Optional[int] = None, + number_instance: Optional["_models.NumberFormat"] = None, + parse_integer_only: Optional[bool] = None, + percent_instance: Optional["_models.NumberFormat"] = None, + rounding_mode: Optional[Union[str, "_models.RoundingMode"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ParentRelation(_model_base.Model): + """The lineage parents relation with GUID of the parent entity and to child entity. + + :ivar child_entity_id: The GUID of child entity. + :vartype child_entity_id: str + :ivar relationship_id: The GUID of relationship. + :vartype relationship_id: str + :ivar parent_entity_id: The GUID of parent entity. + :vartype parent_entity_id: str + """ + + child_entity_id: Optional[str] = rest_field(name="childEntityId") + """The GUID of child entity.""" + relationship_id: Optional[str] = rest_field(name="relationshipId") + """The GUID of relationship.""" + parent_entity_id: Optional[str] = rest_field(name="parentEntityId") + """The GUID of parent entity.""" + + @overload + def __init__( + self, + *, + child_entity_id: Optional[str] = None, + relationship_id: Optional[str] = None, + parent_entity_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PurviewObjectId(_model_base.Model): + """PurviewObjectId. + + :ivar guid: The GUID of the object. + :vartype guid: str + :ivar type_name: The name of the type. + :vartype type_name: str + :ivar unique_attributes: The unique attributes of the object. + :vartype unique_attributes: dict[str, any] + :ivar name: Name. + :vartype name: str + :ivar display_text: Display text. + :vartype display_text: str + :ivar item_path: Item path. + :vartype item_path: str + :ivar resource_id: Resource Id. + :vartype resource_id: str + :ivar properties: Dictionary of :code:``. + :vartype properties: dict[str, any] + """ + + guid: Optional[str] = rest_field() + """The GUID of the object.""" + type_name: Optional[str] = rest_field(name="typeName") + """The name of the type.""" + unique_attributes: Optional[Dict[str, Any]] = rest_field(name="uniqueAttributes") + """The unique attributes of the object.""" + name: Optional[str] = rest_field() + """Name.""" + display_text: Optional[str] = rest_field(name="displayText") + """Display text.""" + item_path: Optional[str] = rest_field(name="itemPath") + """Item path.""" + resource_id: Optional[str] = rest_field(name="resourceId") + """Resource Id.""" + properties: Optional[Dict[str, Any]] = rest_field() + """Dictionary of :code:``.""" + + @overload + def __init__( + self, + *, + guid: Optional[str] = None, + type_name: Optional[str] = None, + unique_attributes: Optional[Dict[str, Any]] = None, + name: Optional[str] = None, + display_text: Optional[str] = None, + item_path: Optional[str] = None, + resource_id: Optional[str] = None, + properties: Optional[Dict[str, Any]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class QueryOptions(_model_base.Model): + """The search query of advanced search request. + + :ivar keywords: The keywords applied to all searchable fields. + :vartype keywords: str + :ivar limit: The limit of the number of the search result. default value is 50; maximum + value is 1000. + :vartype limit: int + :ivar continuation_token: The token used to get next batch of data. Default 'Null' to get the + first + batch, and will return new token in each response unless there's no more data. + :vartype continuation_token: str + :ivar orderby: The sort order of search results, can specify multiple fields. + :vartype orderby: list[any] + :ivar filter: The filter for the search. See examples for the usage of supported filters. + :vartype filter: any + :ivar facets: The facets for search. See examples for the usage of supported facets. + :vartype facets: list[~azure.purview.datamap.models.SearchFacetItem] + :ivar taxonomy_setting: The taxonomy setting for search. + :vartype taxonomy_setting: ~azure.purview.datamap.models.SearchTaxonomySetting + """ + + keywords: Optional[str] = rest_field() + """The keywords applied to all searchable fields.""" + limit: Optional[int] = rest_field() + """The limit of the number of the search result. default value is 50; maximum + value is 1000.""" + continuation_token: Optional[str] = rest_field(name="continuationToken") + """The token used to get next batch of data. Default 'Null' to get the first + batch, and will return new token in each response unless there's no more data.""" + orderby: Optional[List[Any]] = rest_field() + """The sort order of search results, can specify multiple fields.""" + filter: Optional[Any] = rest_field() + """The filter for the search. See examples for the usage of supported filters.""" + facets: Optional[List["_models.SearchFacetItem"]] = rest_field() + """The facets for search. See examples for the usage of supported facets.""" + taxonomy_setting: Optional["_models.SearchTaxonomySetting"] = rest_field(name="taxonomySetting") + """The taxonomy setting for search.""" + + @overload + def __init__( + self, + *, + keywords: Optional[str] = None, + limit: Optional[int] = None, + continuation_token: Optional[str] = None, + orderby: Optional[List[Any]] = None, + filter: Optional[Any] = None, # pylint: disable=redefined-builtin + facets: Optional[List["_models.SearchFacetItem"]] = None, + taxonomy_setting: Optional["_models.SearchTaxonomySetting"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class QueryResult(_model_base.Model): + """The result of the search result. + + :ivar search_count: The total number of search results (not the number of documents in a single + page). + :vartype search_count: int + :ivar search_count_approximate: 'True' if the '@search.count' is an approximate value and vise + versa. + :vartype search_count_approximate: bool + :ivar continuation_token: The token used to get next batch of data. Absent if there's no more + data. + :vartype continuation_token: str + :ivar search_facets: A facet list that consists of index fields assetType ,classification, + contactId, and label. When the facet is specified in the request, the value of + the facet is returned as an element of @search.facets. + :vartype search_facets: ~azure.purview.datamap.models.SearchFacetResultValue + :ivar value: Search result value. + :vartype value: list[~azure.purview.datamap.models.SearchResultValue] + """ + + search_count: Optional[int] = rest_field(name="@search.count") + """The total number of search results (not the number of documents in a single + page).""" + search_count_approximate: Optional[bool] = rest_field(name="@search.count.approximate") + """'True' if the '@search.count' is an approximate value and vise versa.""" + continuation_token: Optional[str] = rest_field(name="continuationToken") + """The token used to get next batch of data. Absent if there's no more data.""" + search_facets: Optional["_models.SearchFacetResultValue"] = rest_field(name="@search.facets") + """A facet list that consists of index fields assetType ,classification, + contactId, and label. When the facet is specified in the request, the value of + the facet is returned as an element of @search.facets.""" + value: Optional[List["_models.SearchResultValue"]] = rest_field() + """Search result value.""" + + @overload + def __init__( + self, + *, + search_count: Optional[int] = None, + search_count_approximate: Optional[bool] = None, + continuation_token: Optional[str] = None, + search_facets: Optional["_models.SearchFacetResultValue"] = None, + value: Optional[List["_models.SearchResultValue"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResourceLink(_model_base.Model): + """ResourceLink. + + :ivar display_name: Display name for url. + :vartype display_name: str + :ivar url: web url. http or https. + :vartype url: str + """ + + display_name: Optional[str] = rest_field(name="displayName") + """Display name for url.""" + url: Optional[str] = rest_field() + """web url. http or https.""" + + @overload + def __init__( + self, + *, + display_name: Optional[str] = None, + url: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SearchFacetItem(_model_base.Model): + """The content of a search facet result item. + + :ivar count: The count of the facet item. + :vartype count: int + :ivar facet: The name of the facet item. + :vartype facet: str + :ivar sort: Define the sorting criteria for items. + :vartype sort: ~azure.purview.datamap.models.SearchFacetSort + """ + + count: Optional[int] = rest_field() + """The count of the facet item.""" + facet: Optional[str] = rest_field() + """The name of the facet item.""" + sort: Optional["_models.SearchFacetSort"] = rest_field() + """Define the sorting criteria for items.""" + + @overload + def __init__( + self, + *, + count: Optional[int] = None, + facet: Optional[str] = None, + sort: Optional["_models.SearchFacetSort"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SearchFacetItemValue(_model_base.Model): + """The content of a search facet result item. + + :ivar count: The count of the facet item. + :vartype count: int + :ivar value: The name of the facet item. + :vartype value: str + """ + + count: Optional[int] = rest_field() + """The count of the facet item.""" + value: Optional[str] = rest_field() + """The name of the facet item.""" + + @overload + def __init__( + self, + *, + count: Optional[int] = None, + value: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SearchFacetResultValue(_model_base.Model): + """A facet list that consists of index fields assetType ,classification, + contactId, and label. When the facet is specified in the request, the value of + the facet is returned as an element of @search.facets. + + :ivar entity_type: Entity type. + :vartype entity_type: list[~azure.purview.datamap.models.SearchFacetItemValue] + :ivar asset_type: Asset type. + :vartype asset_type: list[~azure.purview.datamap.models.SearchFacetItemValue] + :ivar classification: Classification. + :vartype classification: list[~azure.purview.datamap.models.SearchFacetItemValue] + :ivar term: Term. + :vartype term: list[~azure.purview.datamap.models.SearchFacetItemValue] + :ivar contact_id: Contact id. + :vartype contact_id: list[~azure.purview.datamap.models.SearchFacetItemValue] + :ivar contact_type: Contact type. + :vartype contact_type: list[~azure.purview.datamap.models.SearchFacetItemValue] + :ivar label: Label. + :vartype label: list[~azure.purview.datamap.models.SearchFacetItemValue] + :ivar glossary_type: Glossary type. + :vartype glossary_type: list[~azure.purview.datamap.models.SearchFacetItemValue] + :ivar term_status: Term status. + :vartype term_status: list[~azure.purview.datamap.models.SearchFacetItemValue] + :ivar term_template: Term template. + :vartype term_template: list[~azure.purview.datamap.models.SearchFacetItemValue] + """ + + entity_type: Optional[List["_models.SearchFacetItemValue"]] = rest_field(name="entityType") + """Entity type.""" + asset_type: Optional[List["_models.SearchFacetItemValue"]] = rest_field(name="assetType") + """Asset type.""" + classification: Optional[List["_models.SearchFacetItemValue"]] = rest_field() + """Classification.""" + term: Optional[List["_models.SearchFacetItemValue"]] = rest_field() + """Term.""" + contact_id: Optional[List["_models.SearchFacetItemValue"]] = rest_field(name="contactId") + """Contact id.""" + contact_type: Optional[List["_models.SearchFacetItemValue"]] = rest_field(name="contactType") + """Contact type.""" + label: Optional[List["_models.SearchFacetItemValue"]] = rest_field() + """Label.""" + glossary_type: Optional[List["_models.SearchFacetItemValue"]] = rest_field(name="glossaryType") + """Glossary type.""" + term_status: Optional[List["_models.SearchFacetItemValue"]] = rest_field(name="termStatus") + """Term status.""" + term_template: Optional[List["_models.SearchFacetItemValue"]] = rest_field(name="termTemplate") + """Term template.""" + + @overload + def __init__( + self, + *, + entity_type: Optional[List["_models.SearchFacetItemValue"]] = None, + asset_type: Optional[List["_models.SearchFacetItemValue"]] = None, + classification: Optional[List["_models.SearchFacetItemValue"]] = None, + term: Optional[List["_models.SearchFacetItemValue"]] = None, + contact_id: Optional[List["_models.SearchFacetItemValue"]] = None, + contact_type: Optional[List["_models.SearchFacetItemValue"]] = None, + label: Optional[List["_models.SearchFacetItemValue"]] = None, + glossary_type: Optional[List["_models.SearchFacetItemValue"]] = None, + term_status: Optional[List["_models.SearchFacetItemValue"]] = None, + term_template: Optional[List["_models.SearchFacetItemValue"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SearchFacetSort(_model_base.Model): + """The sorting criteria. + + :ivar count: Order by count. Known values are: "asc" and "desc". + :vartype count: str or ~azure.purview.datamap.models.SearchSortOrder + :ivar value: Order by value. Known values are: "asc" and "desc". + :vartype value: str or ~azure.purview.datamap.models.SearchSortOrder + """ + + count: Optional[Union[str, "_models.SearchSortOrder"]] = rest_field() + """Order by count. Known values are: \"asc\" and \"desc\".""" + value: Optional[Union[str, "_models.SearchSortOrder"]] = rest_field() + """Order by value. Known values are: \"asc\" and \"desc\".""" + + @overload + def __init__( + self, + *, + count: Optional[Union[str, "_models.SearchSortOrder"]] = None, + value: Optional[Union[str, "_models.SearchSortOrder"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SearchHighlights(_model_base.Model): + """A highlight list that consists of index fields id ,qualifiedName, name, + description, entityType. When the keyword appears in those fields, the value of + the field, attached with emphasis mark, is returned as an element of + @search.highlights. + + :ivar id: Id. + :vartype id: list[str] + :ivar qualified_name: Qualified name. + :vartype qualified_name: list[str] + :ivar name: Name. + :vartype name: list[str] + :ivar description: Description. + :vartype description: list[str] + :ivar entity_type: Entity type. + :vartype entity_type: list[str] + """ + + id: Optional[List[str]] = rest_field() + """Id.""" + qualified_name: Optional[List[str]] = rest_field(name="qualifiedName") + """Qualified name.""" + name: Optional[List[str]] = rest_field() + """Name.""" + description: Optional[List[str]] = rest_field() + """Description.""" + entity_type: Optional[List[str]] = rest_field(name="entityType") + """Entity type.""" + + @overload + def __init__( + self, + *, + id: Optional[List[str]] = None, # pylint: disable=redefined-builtin + qualified_name: Optional[List[str]] = None, + name: Optional[List[str]] = None, + description: Optional[List[str]] = None, + entity_type: Optional[List[str]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SearchResultValue(_model_base.Model): # pylint: disable=too-many-instance-attributes + """The value item of the search result. + + :ivar search_score: The search score calculated by the search engine. The results are ordered + by + search score by default. + :vartype search_score: float + :ivar search_highlights: A highlight list that consists of index fields id ,qualifiedName, + name, + description, entityType. When the keyword appears in those fields, the value of + the field, attached with emphasis mark, is returned as an element of + @search.highlights. + :vartype search_highlights: ~azure.purview.datamap.models.SearchHighlights + :ivar object_type: The object type of the record. Object type is the top-level property to + distinguish whether a record is an asset or a term. + :vartype object_type: str + :ivar create_time: The create time of the record. The Unix epoch format. + :vartype create_time: int + :ivar update_time: The last update time of the record. The Unix epoch format. + :vartype update_time: int + :ivar id: The GUID of the record. + :vartype id: str + :ivar name: The name of the record. + :vartype name: str + :ivar qualified_name: The qualified name of the record. + :vartype qualified_name: str + :ivar entity_type: The type name of the asset. + :vartype entity_type: str + :ivar description: The description of the asset. + :vartype description: str + :ivar endorsement: The endorsement of the asset. + :vartype endorsement: str + :ivar owner: The owner of the record. + :vartype owner: str + :ivar classification: The classifications of the record. + :vartype classification: list[str] + :ivar label: The labels of the asset. + :vartype label: list[str] + :ivar term: The terms assigned to the asset. + :vartype term: list[~azure.purview.datamap.models.TermSearchResultValue] + :ivar contact: The contacts of the asset. + :vartype contact: list[~azure.purview.datamap.models.ContactSearchResultValue] + :ivar asset_type: The asset types of the asset. + :vartype asset_type: list[str] + :ivar glossary_type: The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or + AtlasGlossaryCategory. + :vartype glossary_type: str + :ivar glossary: The glossary name of the term. + :vartype glossary: str + :ivar term_status: The status of the term. + :vartype term_status: str + :ivar term_template: The term template names used by the term. + :vartype term_template: list[str] + :ivar long_description: The definition of the term. + :vartype long_description: str + """ + + search_score: Optional[float] = rest_field(name="@search.score") + """The search score calculated by the search engine. The results are ordered by + search score by default.""" + search_highlights: Optional["_models.SearchHighlights"] = rest_field(name="@search.highlights") + """A highlight list that consists of index fields id ,qualifiedName, name, + description, entityType. When the keyword appears in those fields, the value of + the field, attached with emphasis mark, is returned as an element of + @search.highlights.""" + object_type: Optional[str] = rest_field(name="objectType") + """The object type of the record. Object type is the top-level property to + distinguish whether a record is an asset or a term.""" + create_time: Optional[int] = rest_field(name="createTime") + """The create time of the record. The Unix epoch format.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The last update time of the record. The Unix epoch format.""" + id: Optional[str] = rest_field() + """The GUID of the record.""" + name: Optional[str] = rest_field() + """The name of the record.""" + qualified_name: Optional[str] = rest_field(name="qualifiedName") + """The qualified name of the record.""" + entity_type: Optional[str] = rest_field(name="entityType") + """The type name of the asset.""" + description: Optional[str] = rest_field() + """The description of the asset.""" + endorsement: Optional[str] = rest_field() + """The endorsement of the asset.""" + owner: Optional[str] = rest_field() + """The owner of the record.""" + classification: Optional[List[str]] = rest_field() + """The classifications of the record.""" + label: Optional[List[str]] = rest_field() + """The labels of the asset.""" + term: Optional[List["_models.TermSearchResultValue"]] = rest_field() + """The terms assigned to the asset.""" + contact: Optional[List["_models.ContactSearchResultValue"]] = rest_field() + """The contacts of the asset.""" + asset_type: Optional[List[str]] = rest_field(name="assetType") + """The asset types of the asset.""" + glossary_type: Optional[str] = rest_field(name="glossaryType") + """The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or + AtlasGlossaryCategory.""" + glossary: Optional[str] = rest_field() + """The glossary name of the term.""" + term_status: Optional[str] = rest_field(name="termStatus") + """The status of the term.""" + term_template: Optional[List[str]] = rest_field(name="termTemplate") + """The term template names used by the term.""" + long_description: Optional[str] = rest_field(name="longDescription") + """The definition of the term.""" + + @overload + def __init__( + self, + *, + search_score: Optional[float] = None, + search_highlights: Optional["_models.SearchHighlights"] = None, + object_type: Optional[str] = None, + create_time: Optional[int] = None, + update_time: Optional[int] = None, + id: Optional[str] = None, # pylint: disable=redefined-builtin + name: Optional[str] = None, + qualified_name: Optional[str] = None, + entity_type: Optional[str] = None, + description: Optional[str] = None, + endorsement: Optional[str] = None, + owner: Optional[str] = None, + classification: Optional[List[str]] = None, + label: Optional[List[str]] = None, + term: Optional[List["_models.TermSearchResultValue"]] = None, + contact: Optional[List["_models.ContactSearchResultValue"]] = None, + asset_type: Optional[List[str]] = None, + glossary_type: Optional[str] = None, + glossary: Optional[str] = None, + term_status: Optional[str] = None, + term_template: Optional[List[str]] = None, + long_description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SearchTaxonomySetting(_model_base.Model): + """Taxonomy setting for search request. + + :ivar asset_types: Asset types. + :vartype asset_types: list[str] + :ivar facet: The content of a search facet result item. + :vartype facet: ~azure.purview.datamap.models.SearchFacetItem + """ + + asset_types: Optional[List[str]] = rest_field(name="assetTypes") + """Asset types.""" + facet: Optional["_models.SearchFacetItem"] = rest_field() + """The content of a search facet result item.""" + + @overload + def __init__( + self, + *, + asset_types: Optional[List[str]] = None, + facet: Optional["_models.SearchFacetItem"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SuggestOptions(_model_base.Model): + """The payload of suggest request. + + :ivar keywords: The keywords applied to all fields that support suggest operation. It must be + at least 1 character, and no more than 100 characters. In the index schema we + defined a default suggester which lists all the supported fields and specifies + a search mode. + :vartype keywords: str + :ivar limit: The number of suggestions we hope to return. The default value is 5. The value + must be a number between 1 and 100. + :vartype limit: int + :ivar filter: The filter for the search. + :vartype filter: any + """ + + keywords: Optional[str] = rest_field() + """The keywords applied to all fields that support suggest operation. It must be + at least 1 character, and no more than 100 characters. In the index schema we + defined a default suggester which lists all the supported fields and specifies + a search mode.""" + limit: Optional[int] = rest_field() + """The number of suggestions we hope to return. The default value is 5. The value + must be a number between 1 and 100.""" + filter: Optional[Any] = rest_field() + """The filter for the search.""" + + @overload + def __init__( + self, + *, + keywords: Optional[str] = None, + limit: Optional[int] = None, + filter: Optional[Any] = None, # pylint: disable=redefined-builtin + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SuggestResult(_model_base.Model): + """The result item of the search suggest. + + :ivar value: The result value. + :vartype value: list[~azure.purview.datamap.models.SuggestResultValue] + """ + + value: Optional[List["_models.SuggestResultValue"]] = rest_field() + """The result value.""" + + @overload + def __init__( + self, + *, + value: Optional[List["_models.SuggestResultValue"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class SuggestResultValue(_model_base.Model): # pylint: disable=too-many-instance-attributes + """The value item of the search suggest. + + :ivar search_score: The search score calculated by the search engine. The results are ordered + by + search score by default. + :vartype search_score: float + :ivar search_text: The target text that contains the keyword as prefix. The keyword is wrapped + with emphasis mark. + :vartype search_text: str + :ivar object_type: The object type of the record. Object type is the top-level property to + distinguish whether a record is an asset or a term. + :vartype object_type: str + :ivar create_time: The create time of the record. The Unix epoch format. + :vartype create_time: int + :ivar update_time: The last update time of the record. The Unix epoch format. + :vartype update_time: int + :ivar id: The GUID of the record. + :vartype id: str + :ivar name: The name of the record. + :vartype name: str + :ivar qualified_name: The qualified name of the record. + :vartype qualified_name: str + :ivar entity_type: The type name of the asset. + :vartype entity_type: str + :ivar description: The description of the asset. + :vartype description: str + :ivar endorsement: The endorsement of the asset. + :vartype endorsement: str + :ivar owner: The owner of the record. + :vartype owner: str + :ivar classification: The classifications of the record. + :vartype classification: list[str] + :ivar label: The labels of the asset. + :vartype label: list[str] + :ivar term: The terms assigned to the asset. + :vartype term: list[~azure.purview.datamap.models.TermSearchResultValue] + :ivar contact: The contacts of the asset. + :vartype contact: list[~azure.purview.datamap.models.ContactSearchResultValue] + :ivar asset_type: The asset types of the asset. + :vartype asset_type: list[str] + :ivar glossary_type: The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or + AtlasGlossaryCategory. + :vartype glossary_type: str + :ivar glossary: The glossary name of the term. + :vartype glossary: str + :ivar term_status: The status of the term. + :vartype term_status: str + :ivar term_template: The term template names used by the term. + :vartype term_template: list[str] + :ivar long_description: The definition of the term. + :vartype long_description: str + """ + + search_score: Optional[float] = rest_field(name="@search.score") + """The search score calculated by the search engine. The results are ordered by + search score by default.""" + search_text: Optional[str] = rest_field(name="@search.text") + """The target text that contains the keyword as prefix. The keyword is wrapped + with emphasis mark.""" + object_type: Optional[str] = rest_field(name="objectType") + """The object type of the record. Object type is the top-level property to + distinguish whether a record is an asset or a term.""" + create_time: Optional[int] = rest_field(name="createTime") + """The create time of the record. The Unix epoch format.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The last update time of the record. The Unix epoch format.""" + id: Optional[str] = rest_field() + """The GUID of the record.""" + name: Optional[str] = rest_field() + """The name of the record.""" + qualified_name: Optional[str] = rest_field(name="qualifiedName") + """The qualified name of the record.""" + entity_type: Optional[str] = rest_field(name="entityType") + """The type name of the asset.""" + description: Optional[str] = rest_field() + """The description of the asset.""" + endorsement: Optional[str] = rest_field() + """The endorsement of the asset.""" + owner: Optional[str] = rest_field() + """The owner of the record.""" + classification: Optional[List[str]] = rest_field() + """The classifications of the record.""" + label: Optional[List[str]] = rest_field() + """The labels of the asset.""" + term: Optional[List["_models.TermSearchResultValue"]] = rest_field() + """The terms assigned to the asset.""" + contact: Optional[List["_models.ContactSearchResultValue"]] = rest_field() + """The contacts of the asset.""" + asset_type: Optional[List[str]] = rest_field(name="assetType") + """The asset types of the asset.""" + glossary_type: Optional[str] = rest_field(name="glossaryType") + """The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or + AtlasGlossaryCategory.""" + glossary: Optional[str] = rest_field() + """The glossary name of the term.""" + term_status: Optional[str] = rest_field(name="termStatus") + """The status of the term.""" + term_template: Optional[List[str]] = rest_field(name="termTemplate") + """The term template names used by the term.""" + long_description: Optional[str] = rest_field(name="longDescription") + """The definition of the term.""" + + @overload + def __init__( + self, + *, + search_score: Optional[float] = None, + search_text: Optional[str] = None, + object_type: Optional[str] = None, + create_time: Optional[int] = None, + update_time: Optional[int] = None, + id: Optional[str] = None, # pylint: disable=redefined-builtin + name: Optional[str] = None, + qualified_name: Optional[str] = None, + entity_type: Optional[str] = None, + description: Optional[str] = None, + endorsement: Optional[str] = None, + owner: Optional[str] = None, + classification: Optional[List[str]] = None, + label: Optional[List[str]] = None, + term: Optional[List["_models.TermSearchResultValue"]] = None, + contact: Optional[List["_models.ContactSearchResultValue"]] = None, + asset_type: Optional[List[str]] = None, + glossary_type: Optional[str] = None, + glossary: Optional[str] = None, + term_status: Optional[str] = None, + term_template: Optional[List[str]] = None, + long_description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TermSearchResultValue(_model_base.Model): + """The context. + + :ivar name: The name of the term. + :vartype name: str + :ivar glossary_name: The name of the glossary which contains the term. + :vartype glossary_name: str + :ivar guid: The GUID of the term. + :vartype guid: str + """ + + name: Optional[str] = rest_field() + """The name of the term.""" + glossary_name: Optional[str] = rest_field(name="glossaryName") + """The name of the glossary which contains the term.""" + guid: Optional[str] = rest_field() + """The GUID of the term.""" + + @overload + def __init__( + self, + *, + name: Optional[str] = None, + glossary_name: Optional[str] = None, + guid: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TermTemplateDef(_model_base.Model): # pylint: disable=too-many-instance-attributes + """Term template definition for glossary term. + + :ivar category: The enum of type category. Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", + "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + :vartype category: str or ~azure.purview.datamap.models.TypeCategory + :ivar create_time: The created time of the record. + :vartype create_time: int + :ivar created_by: The user who created the record. + :vartype created_by: str + :ivar date_formatter: The date format. + :vartype date_formatter: ~azure.purview.datamap.models.DateFormat + :ivar description: The description of the type definition. + :vartype description: str + :ivar guid: The GUID of the type definition. + :vartype guid: str + :ivar name: The name of the type definition. + :vartype name: str + :ivar options: The options for the type definition. + :vartype options: dict[str, str] + :ivar service_type: The service type. + :vartype service_type: str + :ivar type_version: The version of the type. + :vartype type_version: str + :ivar update_time: The update time of the record. + :vartype update_time: int + :ivar updated_by: The user who updated the record. + :vartype updated_by: str + :ivar version: The version of the record. + :vartype version: int + :ivar last_modified_t_s: ETag for concurrency control. + :vartype last_modified_t_s: str + :ivar attribute_defs: An array of attribute definitions. + :vartype attribute_defs: list[~azure.purview.datamap.models.AtlasAttributeDef] + """ + + category: Optional[Union[str, "_models.TypeCategory"]] = rest_field() + """The enum of type category. Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", + \"STRUCT\", \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"MAP\", \"RELATIONSHIP\", and + \"TERM_TEMPLATE\".""" + create_time: Optional[int] = rest_field(name="createTime") + """The created time of the record.""" + created_by: Optional[str] = rest_field(name="createdBy") + """The user who created the record.""" + date_formatter: Optional["_models.DateFormat"] = rest_field(name="dateFormatter") + """The date format.""" + description: Optional[str] = rest_field() + """The description of the type definition.""" + guid: Optional[str] = rest_field() + """The GUID of the type definition.""" + name: Optional[str] = rest_field() + """The name of the type definition.""" + options: Optional[Dict[str, str]] = rest_field() + """The options for the type definition.""" + service_type: Optional[str] = rest_field(name="serviceType") + """The service type.""" + type_version: Optional[str] = rest_field(name="typeVersion") + """The version of the type.""" + update_time: Optional[int] = rest_field(name="updateTime") + """The update time of the record.""" + updated_by: Optional[str] = rest_field(name="updatedBy") + """The user who updated the record.""" + version: Optional[int] = rest_field() + """The version of the record.""" + last_modified_t_s: Optional[str] = rest_field(name="lastModifiedTS") + """ETag for concurrency control.""" + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = rest_field(name="attributeDefs") + """An array of attribute definitions.""" + + @overload + def __init__( + self, + *, + category: Optional[Union[str, "_models.TypeCategory"]] = None, + create_time: Optional[int] = None, + created_by: Optional[str] = None, + date_formatter: Optional["_models.DateFormat"] = None, + description: Optional[str] = None, + guid: Optional[str] = None, + name: Optional[str] = None, + options: Optional[Dict[str, str]] = None, + service_type: Optional[str] = None, + type_version: Optional[str] = None, + update_time: Optional[int] = None, + updated_by: Optional[str] = None, + version: Optional[int] = None, + last_modified_t_s: Optional[str] = None, + attribute_defs: Optional[List["_models.AtlasAttributeDef"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TimeBoundary(_model_base.Model): + """Captures time-boundary details. + + :ivar end_time: The end of the time boundary. + :vartype end_time: str + :ivar start_time: The start of the time boundary. + :vartype start_time: str + :ivar time_zone: The timezone of the time boundary. + :vartype time_zone: str + """ + + end_time: Optional[str] = rest_field(name="endTime") + """The end of the time boundary.""" + start_time: Optional[str] = rest_field(name="startTime") + """The start of the time boundary.""" + time_zone: Optional[str] = rest_field(name="timeZone") + """The timezone of the time boundary.""" + + @overload + def __init__( + self, + *, + end_time: Optional[str] = None, + start_time: Optional[str] = None, + time_zone: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TimeZone(_model_base.Model): + """The timezone information. + + :ivar dst_savings: The value of the daylight saving time. + :vartype dst_savings: int + :ivar id: The ID of the timezone. + :vartype id: str + :ivar available_ids: An array of available IDs. + :vartype available_ids: list[str] + :ivar default: The timezone information. + :vartype default: ~azure.purview.datamap.models.TimeZone + :ivar display_name: The display name of the timezone. + :vartype display_name: str + :ivar raw_offset: The raw offset of the timezone. + :vartype raw_offset: int + """ + + dst_savings: Optional[int] = rest_field(name="dstSavings") + """The value of the daylight saving time.""" + id: Optional[str] = rest_field() + """The ID of the timezone.""" + available_ids: Optional[List[str]] = rest_field(name="availableIds") + """An array of available IDs.""" + default: Optional["_models.TimeZone"] = rest_field() + """The timezone information.""" + display_name: Optional[str] = rest_field(name="displayName") + """The display name of the timezone.""" + raw_offset: Optional[int] = rest_field(name="rawOffset") + """The raw offset of the timezone.""" + + @overload + def __init__( + self, + *, + dst_savings: Optional[int] = None, + id: Optional[str] = None, # pylint: disable=redefined-builtin + available_ids: Optional[List[str]] = None, + default: Optional["_models.TimeZone"] = None, + display_name: Optional[str] = None, + raw_offset: Optional[int] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/_patch.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/operations/__init__.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/operations/__init__.py new file mode 100644 index 000000000000..f87703413c74 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/operations/__init__.py @@ -0,0 +1,29 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import EntityOperations +from ._operations import GlossaryOperations +from ._operations import DiscoveryOperations +from ._operations import LineageOperations +from ._operations import RelationshipOperations +from ._operations import TypeDefinitionOperations + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "EntityOperations", + "GlossaryOperations", + "DiscoveryOperations", + "LineageOperations", + "RelationshipOperations", + "TypeDefinitionOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/operations/_operations.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/operations/_operations.py new file mode 100644 index 000000000000..5f173434eb7d --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/operations/_operations.py @@ -0,0 +1,47261 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, List, Optional, TypeVar, Union, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._model_base import SdkJSONEncoder, _deserialize +from .._serialization import Serializer + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +_Unset: Any = object() +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_entity_create_or_update_request( + *, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + collection_id: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity" + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if business_attribute_update_behavior is not None: + _params["businessAttributeUpdateBehavior"] = _SERIALIZER.query( + "business_attribute_update_behavior", business_attribute_update_behavior, "str" + ) + if collection_id is not None: + _params["collectionId"] = _SERIALIZER.query("collection_id", collection_id, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_get_by_ids_request( + *, guid: List[str], min_ext_info: Optional[bool] = None, ignore_relationships: Optional[bool] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/bulk" + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + _params["guid"] = [_SERIALIZER.query("guid", q, "str") if q is not None else "" for q in guid] + if min_ext_info is not None: + _params["minExtInfo"] = _SERIALIZER.query("min_ext_info", min_ext_info, "bool") + if ignore_relationships is not None: + _params["ignoreRelationships"] = _SERIALIZER.query("ignore_relationships", ignore_relationships, "bool") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_batch_create_or_update_request( # pylint: disable=name-too-long + *, + collection_id: Optional[str] = None, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/bulk" + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if collection_id is not None: + _params["collectionId"] = _SERIALIZER.query("collection_id", collection_id, "str") + if business_attribute_update_behavior is not None: + _params["businessAttributeUpdateBehavior"] = _SERIALIZER.query( + "business_attribute_update_behavior", business_attribute_update_behavior, "str" + ) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_batch_delete_request(*, guid: List[str], **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/bulk" + + # Construct parameters + _params["guid"] = [_SERIALIZER.query("guid", q, "str") if q is not None else "" for q in guid] + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_add_classification_request(**kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/bulk/classification" + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_entity_get_request( + guid: str, *, min_ext_info: Optional[bool] = None, ignore_relationships: Optional[bool] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if min_ext_info is not None: + _params["minExtInfo"] = _SERIALIZER.query("min_ext_info", min_ext_info, "bool") + if ignore_relationships is not None: + _params["ignoreRelationships"] = _SERIALIZER.query("ignore_relationships", ignore_relationships, "bool") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_update_attribute_by_id_request( # pylint: disable=name-too-long + guid: str, *, name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["name"] = _SERIALIZER.query("name", name, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_delete_request(guid: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) + + +def build_entity_get_classification_request(guid: str, classification_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/classification/{classificationName}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + "classificationName": _SERIALIZER.url("classification_name", classification_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_entity_remove_classification_request( # pylint: disable=name-too-long + guid: str, classification_name: str, **kwargs: Any +) -> HttpRequest: + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/classification/{classificationName}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + "classificationName": _SERIALIZER.url("classification_name", classification_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + return HttpRequest(method="DELETE", url=_url, **kwargs) + + +def build_entity_get_classifications_request(guid: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/classifications" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_entity_add_classifications_request(guid: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/classifications" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_entity_update_classifications_request( # pylint: disable=name-too-long + guid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/classifications" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, headers=_headers, **kwargs) + + +def build_entity_get_by_unique_attribute_request( # pylint: disable=name-too-long + type_name: str, + *, + min_ext_info: Optional[bool] = None, + ignore_relationships: Optional[bool] = None, + attribute: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/uniqueAttribute/type/{typeName}" + path_format_arguments = { + "typeName": _SERIALIZER.url("type_name", type_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if min_ext_info is not None: + _params["minExtInfo"] = _SERIALIZER.query("min_ext_info", min_ext_info, "bool") + if ignore_relationships is not None: + _params["ignoreRelationships"] = _SERIALIZER.query("ignore_relationships", ignore_relationships, "bool") + if attribute is not None: + _params["attr:qualifiedName"] = _SERIALIZER.query("attribute", attribute, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_update_by_unique_attribute_request( # pylint: disable=name-too-long + type_name: str, *, attribute: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/uniqueAttribute/type/{typeName}" + path_format_arguments = { + "typeName": _SERIALIZER.url("type_name", type_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if attribute is not None: + _params["attr:qualifiedName"] = _SERIALIZER.query("attribute", attribute, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_delete_by_unique_attribute_request( # pylint: disable=name-too-long + type_name: str, *, attribute: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/uniqueAttribute/type/{typeName}" + path_format_arguments = { + "typeName": _SERIALIZER.url("type_name", type_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if attribute is not None: + _params["attr:qualifiedName"] = _SERIALIZER.query("attribute", attribute, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_remove_classification_by_unique_attribute_request( # pylint: disable=name-too-long + type_name: str, classification_name: str, *, attribute: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + # Construct URL + _url = "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}" + path_format_arguments = { + "typeName": _SERIALIZER.url("type_name", type_name, "str"), + "classificationName": _SERIALIZER.url("classification_name", classification_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if attribute is not None: + _params["attr:qualifiedName"] = _SERIALIZER.query("attribute", attribute, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) + + +def build_entity_add_classifications_by_unique_attribute_request( # pylint: disable=name-too-long + type_name: str, *, attribute: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications" + path_format_arguments = { + "typeName": _SERIALIZER.url("type_name", type_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if attribute is not None: + _params["attr:qualifiedName"] = _SERIALIZER.query("attribute", attribute, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_update_classifications_unique_by_attribute_request( # pylint: disable=name-too-long + type_name: str, *, attribute: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications" + path_format_arguments = { + "typeName": _SERIALIZER.url("type_name", type_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if attribute is not None: + _params["attr:qualifiedName"] = _SERIALIZER.query("attribute", attribute, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_batch_set_classifications_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/bulk/setClassifications" + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_entity_batch_get_by_unique_attributes_request( # pylint: disable=name-too-long + type_name: str, + *, + min_ext_info: Optional[bool] = None, + ignore_relationships: Optional[bool] = None, + attr_n_qualified_name: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}" + path_format_arguments = { + "typeName": _SERIALIZER.url("type_name", type_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if min_ext_info is not None: + _params["minExtInfo"] = _SERIALIZER.query("min_ext_info", min_ext_info, "bool") + if ignore_relationships is not None: + _params["ignoreRelationships"] = _SERIALIZER.query("ignore_relationships", ignore_relationships, "bool") + if attr_n_qualified_name is not None: + _params["attr_N:qualifiedName"] = _SERIALIZER.query("attr_n_qualified_name", attr_n_qualified_name, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_get_header_request(guid: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/header" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_entity_remove_business_metadata_request( # pylint: disable=name-too-long + guid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/businessmetadata" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) + + +def build_entity_add_or_update_business_metadata_request( # pylint: disable=name-too-long + guid: str, *, overwrite: Optional[bool] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/businessmetadata" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if overwrite is not None: + _params["isOverwrite"] = _SERIALIZER.query("overwrite", overwrite, "bool") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_remove_business_metadata_attributes_request( # pylint: disable=name-too-long + business_metadata_name: str, guid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}" + path_format_arguments = { + "businessMetadataName": _SERIALIZER.url("business_metadata_name", business_metadata_name, "str"), + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) + + +def build_entity_add_or_update_business_metadata_attributes_request( # pylint: disable=name-too-long + business_metadata_name: str, guid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}" + path_format_arguments = { + "businessMetadataName": _SERIALIZER.url("business_metadata_name", business_metadata_name, "str"), + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_entity_get_business_metadata_template_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/octet-stream") + + # Construct URL + _url = "/atlas/v2/entity/businessmetadata/import/template" + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_entity_import_business_metadata_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/entity/businessmetadata/import" + + # Construct headers + if content_type is not None: + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_entity_remove_labels_request(guid: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/labels" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) + + +def build_entity_set_labels_request(guid: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/labels" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_entity_add_label_request(guid: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/guid/{guid}/labels" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, headers=_headers, **kwargs) + + +def build_entity_remove_labels_by_unique_attribute_request( # pylint: disable=name-too-long + type_name: str, *, attribute: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels" + path_format_arguments = { + "typeName": _SERIALIZER.url("type_name", type_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if attribute is not None: + _params["attr:qualifiedName"] = _SERIALIZER.query("attribute", attribute, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_set_labels_by_unique_attribute_request( # pylint: disable=name-too-long + type_name: str, *, attribute: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels" + path_format_arguments = { + "typeName": _SERIALIZER.url("type_name", type_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if attribute is not None: + _params["attr:qualifiedName"] = _SERIALIZER.query("attribute", attribute, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_add_labels_by_unique_attribute_request( # pylint: disable=name-too-long + type_name: str, *, attribute: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels" + path_format_arguments = { + "typeName": _SERIALIZER.url("type_name", type_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if attribute is not None: + _params["attr:qualifiedName"] = _SERIALIZER.query("attribute", attribute, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_entity_move_entities_to_collection_request( # pylint: disable=name-too-long + *, collection_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/entity/moveTo" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + _params["collectionId"] = _SERIALIZER.query("collection_id", collection_id, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_batch_get_request( + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + ignore_terms_and_categories: Optional[bool] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary" + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if limit is not None: + _params["limit"] = _SERIALIZER.query("limit", limit, "int") + if offset is not None: + _params["offset"] = _SERIALIZER.query("offset", offset, "int") + if sort is not None: + _params["sort"] = _SERIALIZER.query("sort", sort, "str") + if ignore_terms_and_categories is not None: + _params["ignoreTermsAndCategories"] = _SERIALIZER.query( + "ignore_terms_and_categories", ignore_terms_and_categories, "bool" + ) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_create_request(**kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary" + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_glossary_create_categories_request(**kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/categories" + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_glossary_create_category_request(**kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/category" + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_glossary_get_category_request(category_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/category/{categoryId}" + path_format_arguments = { + "categoryId": _SERIALIZER.url("category_id", category_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_glossary_update_category_request(category_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/category/{categoryId}" + path_format_arguments = { + "categoryId": _SERIALIZER.url("category_id", category_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, headers=_headers, **kwargs) + + +def build_glossary_delete_category_request(category_id: str, **kwargs: Any) -> HttpRequest: + # Construct URL + _url = "/atlas/v2/glossary/category/{categoryId}" + path_format_arguments = { + "categoryId": _SERIALIZER.url("category_id", category_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + return HttpRequest(method="DELETE", url=_url, **kwargs) + + +def build_glossary_partial_update_category_request( # pylint: disable=name-too-long + category_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/category/{categoryId}/partial" + path_format_arguments = { + "categoryId": _SERIALIZER.url("category_id", category_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, headers=_headers, **kwargs) + + +def build_glossary_get_related_categories_request( # pylint: disable=name-too-long + category_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/category/{categoryId}/related" + path_format_arguments = { + "categoryId": _SERIALIZER.url("category_id", category_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if limit is not None: + _params["limit"] = _SERIALIZER.query("limit", limit, "int") + if offset is not None: + _params["offset"] = _SERIALIZER.query("offset", offset, "int") + if sort is not None: + _params["sort"] = _SERIALIZER.query("sort", sort, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_get_category_terms_request( # pylint: disable=name-too-long + category_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/category/{categoryId}/terms" + path_format_arguments = { + "categoryId": _SERIALIZER.url("category_id", category_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if limit is not None: + _params["limit"] = _SERIALIZER.query("limit", limit, "int") + if offset is not None: + _params["offset"] = _SERIALIZER.query("offset", offset, "int") + if sort is not None: + _params["sort"] = _SERIALIZER.query("sort", sort, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_create_term_request(*, include_term_hierarchy: Optional[bool] = None, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/term" + + # Construct parameters + if include_term_hierarchy is not None: + _params["includeTermHierarchy"] = _SERIALIZER.query("include_term_hierarchy", include_term_hierarchy, "bool") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_get_term_request(term_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/term/{termId}" + path_format_arguments = { + "termId": _SERIALIZER.url("term_id", term_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_update_term_request( + term_id: str, *, include_term_hierarchy: Optional[bool] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/term/{termId}" + path_format_arguments = { + "termId": _SERIALIZER.url("term_id", term_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if include_term_hierarchy is not None: + _params["includeTermHierarchy"] = _SERIALIZER.query("include_term_hierarchy", include_term_hierarchy, "bool") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_delete_term_request(term_id: str, **kwargs: Any) -> HttpRequest: + # Construct URL + _url = "/atlas/v2/glossary/term/{termId}" + path_format_arguments = { + "termId": _SERIALIZER.url("term_id", term_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + return HttpRequest(method="DELETE", url=_url, **kwargs) + + +def build_glossary_partial_update_term_request( # pylint: disable=name-too-long + term_id: str, *, include_term_hierarchy: Optional[bool] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/term/{termId}/partial" + path_format_arguments = { + "termId": _SERIALIZER.url("term_id", term_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if include_term_hierarchy is not None: + _params["includeTermHierarchy"] = _SERIALIZER.query("include_term_hierarchy", include_term_hierarchy, "bool") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_create_terms_request(*, include_term_hierarchy: Optional[bool] = None, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/terms" + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if include_term_hierarchy is not None: + _params["includeTermHierarchy"] = _SERIALIZER.query("include_term_hierarchy", include_term_hierarchy, "bool") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_get_entities_assigned_with_term_request( # pylint: disable=name-too-long + term_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/terms/{termId}/assignedEntities" + path_format_arguments = { + "termId": _SERIALIZER.url("term_id", term_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if limit is not None: + _params["limit"] = _SERIALIZER.query("limit", limit, "int") + if offset is not None: + _params["offset"] = _SERIALIZER.query("offset", offset, "int") + if sort is not None: + _params["sort"] = _SERIALIZER.query("sort", sort, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_assign_term_to_entities_request( # pylint: disable=name-too-long + term_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/glossary/terms/{termId}/assignedEntities" + path_format_arguments = { + "termId": _SERIALIZER.url("term_id", term_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_glossary_delete_term_assignment_from_entities_request( # pylint: disable=name-too-long + term_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/glossary/terms/{termId}/assignedEntities" + path_format_arguments = { + "termId": _SERIALIZER.url("term_id", term_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) + + +def build_glossary_get_related_terms_request( + term_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/terms/{termId}/related" + path_format_arguments = { + "termId": _SERIALIZER.url("term_id", term_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if limit is not None: + _params["limit"] = _SERIALIZER.query("limit", limit, "int") + if offset is not None: + _params["offset"] = _SERIALIZER.query("offset", offset, "int") + if sort is not None: + _params["sort"] = _SERIALIZER.query("sort", sort, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_get_request(glossary_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/{glossaryId}" + path_format_arguments = { + "glossaryId": _SERIALIZER.url("glossary_id", glossary_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_glossary_update_request( + glossary_id: str, *, ignore_terms_and_categories: Optional[bool] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/{glossaryId}" + path_format_arguments = { + "glossaryId": _SERIALIZER.url("glossary_id", glossary_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if ignore_terms_and_categories is not None: + _params["ignoreTermsAndCategories"] = _SERIALIZER.query( + "ignore_terms_and_categories", ignore_terms_and_categories, "bool" + ) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_delete_request(glossary_id: str, **kwargs: Any) -> HttpRequest: + # Construct URL + _url = "/atlas/v2/glossary/{glossaryId}" + path_format_arguments = { + "glossaryId": _SERIALIZER.url("glossary_id", glossary_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + return HttpRequest(method="DELETE", url=_url, **kwargs) + + +def build_glossary_get_categories_request( + glossary_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/{glossaryId}/categories" + path_format_arguments = { + "glossaryId": _SERIALIZER.url("glossary_id", glossary_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if limit is not None: + _params["limit"] = _SERIALIZER.query("limit", limit, "int") + if offset is not None: + _params["offset"] = _SERIALIZER.query("offset", offset, "int") + if sort is not None: + _params["sort"] = _SERIALIZER.query("sort", sort, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_get_categories_headers_request( # pylint: disable=name-too-long + glossary_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/{glossaryId}/categories/headers" + path_format_arguments = { + "glossaryId": _SERIALIZER.url("glossary_id", glossary_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if limit is not None: + _params["limit"] = _SERIALIZER.query("limit", limit, "int") + if offset is not None: + _params["offset"] = _SERIALIZER.query("offset", offset, "int") + if sort is not None: + _params["sort"] = _SERIALIZER.query("sort", sort, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_get_detailed_request(glossary_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/{glossaryId}/detailed" + path_format_arguments = { + "glossaryId": _SERIALIZER.url("glossary_id", glossary_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_partial_update_request( + glossary_id: str, *, ignore_terms_and_categories: Optional[bool] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/{glossaryId}/partial" + path_format_arguments = { + "glossaryId": _SERIALIZER.url("glossary_id", glossary_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if ignore_terms_and_categories is not None: + _params["ignoreTermsAndCategories"] = _SERIALIZER.query( + "ignore_terms_and_categories", ignore_terms_and_categories, "bool" + ) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_get_terms_request( + glossary_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/{glossaryId}/terms" + path_format_arguments = { + "glossaryId": _SERIALIZER.url("glossary_id", glossary_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if limit is not None: + _params["limit"] = _SERIALIZER.query("limit", limit, "int") + if offset is not None: + _params["offset"] = _SERIALIZER.query("offset", offset, "int") + if sort is not None: + _params["sort"] = _SERIALIZER.query("sort", sort, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_glossary_get_term_headers_request( + glossary_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/glossary/{glossaryId}/terms/headers" + path_format_arguments = { + "glossaryId": _SERIALIZER.url("glossary_id", glossary_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if limit is not None: + _params["limit"] = _SERIALIZER.query("limit", limit, "int") + if offset is not None: + _params["offset"] = _SERIALIZER.query("offset", offset, "int") + if sort is not None: + _params["sort"] = _SERIALIZER.query("sort", sort, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_discovery_query_request(**kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/search/query" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_discovery_suggest_request(**kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/search/suggest" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_discovery_auto_complete_request(**kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/search/autocomplete" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_lineage_get_request( + guid: str, *, direction: Union[str, _models.LineageDirection], depth: Optional[int] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/lineage/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if depth is not None: + _params["depth"] = _SERIALIZER.query("depth", depth, "int") + _params["direction"] = _SERIALIZER.query("direction", direction, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_lineage_get_next_page_request( + guid: str, + *, + direction: Union[str, _models.LineageDirection], + offset: Optional[int] = None, + limit: Optional[int] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/lineage/{guid}/next" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + _params["direction"] = _SERIALIZER.query("direction", direction, "str") + if offset is not None: + _params["offset"] = _SERIALIZER.query("offset", offset, "int") + if limit is not None: + _params["limit"] = _SERIALIZER.query("limit", limit, "int") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_lineage_get_by_unique_attribute_request( # pylint: disable=name-too-long + type_name: str, + *, + direction: Union[str, _models.LineageDirection], + depth: Optional[int] = None, + attribute: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/lineage/uniqueAttribute/type/{typeName}" + path_format_arguments = { + "typeName": _SERIALIZER.url("type_name", type_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if depth is not None: + _params["depth"] = _SERIALIZER.query("depth", depth, "int") + _params["direction"] = _SERIALIZER.query("direction", direction, "str") + if attribute is not None: + _params["attr:qualifiedName"] = _SERIALIZER.query("attribute", attribute, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_relationship_create_request(**kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/relationship" + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_relationship_update_request(**kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/relationship" + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, headers=_headers, **kwargs) + + +def build_relationship_get_request(guid: str, *, extended_info: Optional[bool] = None, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/relationship/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if extended_info is not None: + _params["extendedInfo"] = _SERIALIZER.query("extended_info", extended_info, "bool") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_relationship_delete_request(guid: str, **kwargs: Any) -> HttpRequest: + # Construct URL + _url = "/atlas/v2/relationship/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + return HttpRequest(method="DELETE", url=_url, **kwargs) + + +def build_type_definition_get_business_metadata_by_id_request( # pylint: disable=name-too-long + guid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/businessmetadatadef/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_business_metadata_by_name_request( # pylint: disable=name-too-long + name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/businessmetadatadef/name/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_classification_by_id_request( # pylint: disable=name-too-long + guid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/classificationdef/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_classification_by_name_request( # pylint: disable=name-too-long + name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/classificationdef/name/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_entity_by_id_request( # pylint: disable=name-too-long + guid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/entitydef/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_entity_by_name_request( # pylint: disable=name-too-long + name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/entitydef/name/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_enum_by_id_request( # pylint: disable=name-too-long + guid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/enumdef/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_enum_by_name_request( # pylint: disable=name-too-long + name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/enumdef/name/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_relationship_by_id_request( # pylint: disable=name-too-long + guid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/relationshipdef/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_relationship_by_name_request( # pylint: disable=name-too-long + name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/relationshipdef/name/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_struct_by_id_request( # pylint: disable=name-too-long + guid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/structdef/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_struct_by_name_request( # pylint: disable=name-too-long + name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/structdef/name/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_by_id_request(guid: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/typedef/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_by_name_request(name: str, **kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/typedef/name/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_delete_request(name: str, **kwargs: Any) -> HttpRequest: + # Construct URL + _url = "/atlas/v2/types/typedef/name/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + return HttpRequest(method="DELETE", url=_url, **kwargs) + + +def build_type_definition_get_request( + *, + include_term_template: Optional[bool] = None, + type: Optional[Union[str, _models.TypeCategory]] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/typedefs" + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if include_term_template is not None: + _params["includeTermTemplate"] = _SERIALIZER.query("include_term_template", include_term_template, "bool") + if type is not None: + _params["type"] = _SERIALIZER.query("type", type, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_type_definition_batch_create_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/typedefs" + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_batch_update_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/typedefs" + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="PUT", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_batch_delete_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + # Construct URL + _url = "/atlas/v2/types/typedefs" + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) + + +def build_type_definition_get_headers_request( # pylint: disable=name-too-long + *, + include_term_template: Optional[bool] = None, + type: Optional[Union[str, _models.TypeCategory]] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/atlas/v2/types/typedefs/headers" + + # Construct parameters + if api_version is not None: + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if include_term_template is not None: + _params["includeTermTemplate"] = _SERIALIZER.query("include_term_template", include_term_template, "bool") + if type is not None: + _params["type"] = _SERIALIZER.query("type", type, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_type_definition_get_term_template_by_id_request( # pylint: disable=name-too-long + guid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/types/termtemplatedef/guid/{guid}" + path_format_arguments = { + "guid": _SERIALIZER.url("guid", guid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_type_definition_get_term_template_by_name_request( # pylint: disable=name-too-long + name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-09-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/types/termtemplatedef/name/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +class EntityOperations: # pylint: disable=too-many-public-methods + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.purview.datamap.DataMapClient`'s + :attr:`entity` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def create_or_update( + self, + body: _models.AtlasEntityWithExtInfo, + *, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + collection_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update an entity. + Existing entity is matched using its unique guid if + supplied or by its unique attributes eg: qualifiedName. + Map and array of + collections are not well supported. E.g., array`>, array>. + For each contact type, the maximum number of contacts is 20. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasEntityWithExtInfo + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entity": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the + term assignment. + "createdBy": "str", # Optional. The user who created + the record. + "description": "str", # Optional. The description of + the term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms + assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", + "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of relationship. + }, + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the entity. + }, + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + def create_or_update( + self, + body: JSON, + *, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + collection_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update an entity. + Existing entity is matched using its unique guid if + supplied or by its unique attributes eg: qualifiedName. + Map and array of + collections are not well supported. E.g., array`>, array>. + For each contact type, the maximum number of contacts is 20. + + :param body: Required. + :type body: JSON + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + def create_or_update( + self, + body: IO[bytes], + *, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + collection_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update an entity. + Existing entity is matched using its unique guid if + supplied or by its unique attributes eg: qualifiedName. + Map and array of + collections are not well supported. E.g., array`>, array>. + For each contact type, the maximum number of contacts is 20. + + :param body: Required. + :type body: IO[bytes] + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @distributed_trace + def create_or_update( + self, + body: Union[_models.AtlasEntityWithExtInfo, JSON, IO[bytes]], + *, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + collection_id: Optional[str] = None, + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update an entity. + Existing entity is matched using its unique guid if + supplied or by its unique attributes eg: qualifiedName. + Map and array of + collections are not well supported. E.g., array`>, array>. + For each contact type, the maximum number of contacts is 20. + + :param body: Is one of the following types: AtlasEntityWithExtInfo, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasEntityWithExtInfo or JSON or IO[bytes] + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entity": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the + term assignment. + "createdBy": "str", # Optional. The user who created + the record. + "description": "str", # Optional. The description of + the term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms + assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", + "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of relationship. + }, + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the entity. + }, + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_create_or_update_request( + business_attribute_update_behavior=business_attribute_update_behavior, + collection_id=collection_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_by_ids( + self, + *, + guid: List[str], + min_ext_info: Optional[bool] = None, + ignore_relationships: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasEntitiesWithExtInfo: + # pylint: disable=line-too-long + """List entities in bulk identified by its GUIDs. + + :keyword guid: An array of GUIDs of entities to list. Required. + :paramtype guid: list[str] + :keyword min_ext_info: Whether to return minimal information for referred entities. Default + value is None. + :paramtype min_ext_info: bool + :keyword ignore_relationships: Whether to ignore relationship attributes. Default value is + None. + :paramtype ignore_relationships: bool + :return: AtlasEntitiesWithExtInfo. The AtlasEntitiesWithExtInfo is compatible with + MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntitiesWithExtInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "entities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + ], + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntitiesWithExtInfo] = kwargs.pop("cls", None) + + _request = build_entity_get_by_ids_request( + guid=guid, + min_ext_info=min_ext_info, + ignore_relationships=ignore_relationships, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntitiesWithExtInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def batch_create_or_update( + self, + body: _models.AtlasEntitiesWithExtInfo, + *, + collection_id: Optional[str] = None, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update entities in bulk. + Existing entity is matched using its unique + guid if supplied or by its unique attributes eg: qualifiedName. + Map and array + of collections are not well supported. E.g., array`>, + array>. + For each contact type, the maximum number of contacts + is 20. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasEntitiesWithExtInfo + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + ], + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + def batch_create_or_update( + self, + body: JSON, + *, + collection_id: Optional[str] = None, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update entities in bulk. + Existing entity is matched using its unique + guid if supplied or by its unique attributes eg: qualifiedName. + Map and array + of collections are not well supported. E.g., array`>, + array>. + For each contact type, the maximum number of contacts + is 20. + + :param body: Required. + :type body: JSON + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + def batch_create_or_update( + self, + body: IO[bytes], + *, + collection_id: Optional[str] = None, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update entities in bulk. + Existing entity is matched using its unique + guid if supplied or by its unique attributes eg: qualifiedName. + Map and array + of collections are not well supported. E.g., array`>, + array>. + For each contact type, the maximum number of contacts + is 20. + + :param body: Required. + :type body: IO[bytes] + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @distributed_trace + def batch_create_or_update( + self, + body: Union[_models.AtlasEntitiesWithExtInfo, JSON, IO[bytes]], + *, + collection_id: Optional[str] = None, + business_attribute_update_behavior: Optional[Union[str, _models.BusinessAttributeUpdateBehavior]] = None, + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Create or update entities in bulk. + Existing entity is matched using its unique + guid if supplied or by its unique attributes eg: qualifiedName. + Map and array + of collections are not well supported. E.g., array`>, + array>. + For each contact type, the maximum number of contacts + is 20. + + :param body: Is one of the following types: AtlasEntitiesWithExtInfo, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasEntitiesWithExtInfo or JSON or IO[bytes] + :keyword collection_id: The collection where entities will be moved to. Only specify a value if + you + need to move an entity to another collection. Default value is None. + :paramtype collection_id: str + :keyword business_attribute_update_behavior: Used to define the update behavior for business + attributes when updating + entities. Known values are: "ignore", "replace", and "merge". Default value is None. + :paramtype business_attribute_update_behavior: str or + ~azure.purview.datamap.models.BusinessAttributeUpdateBehavior + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + ], + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_batch_create_or_update_request( + collection_id=collection_id, + business_attribute_update_behavior=business_attribute_update_behavior, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def batch_delete(self, *, guid: List[str], **kwargs: Any) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Delete a list of entities in bulk identified by their GUIDs or unique + attributes. + + :keyword guid: An array of GUIDs of entities to delete. Required. + :paramtype guid: list[str] + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + _request = build_entity_batch_delete_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def add_classification( # pylint: disable=inconsistent-return-statements + self, body: _models.ClassificationAssociateOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Associate a classification to multiple entities in bulk. + + :param body: Required. + :type body: ~azure.purview.datamap.models.ClassificationAssociateOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "classification": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time + boundary. + "startTime": "str", # Optional. The start of the + time boundary. + "timeZone": "str" # Optional. The timezone of the + time boundary. + } + ] + }, + "entityGuids": [ + "str" # Optional. The GUID of the entity. + ] + } + """ + + @overload + def add_classification( # pylint: disable=inconsistent-return-statements + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Associate a classification to multiple entities in bulk. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def add_classification( # pylint: disable=inconsistent-return-statements + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Associate a classification to multiple entities in bulk. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def add_classification( # pylint: disable=inconsistent-return-statements + self, body: Union[_models.ClassificationAssociateOptions, JSON, IO[bytes]], **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Associate a classification to multiple entities in bulk. + + :param body: Is one of the following types: ClassificationAssociateOptions, JSON, IO[bytes] + Required. + :type body: ~azure.purview.datamap.models.ClassificationAssociateOptions or JSON or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "classification": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time + boundary. + "startTime": "str", # Optional. The start of the + time boundary. + "timeZone": "str" # Optional. The timezone of the + time boundary. + } + ] + }, + "entityGuids": [ + "str" # Optional. The GUID of the entity. + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_add_classification_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def get( + self, + guid: str, + *, + min_ext_info: Optional[bool] = None, + ignore_relationships: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasEntityWithExtInfo: + # pylint: disable=line-too-long + """Get complete definition of an entity given its GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :keyword min_ext_info: Whether to return minimal information for referred entities. Default + value is None. + :paramtype min_ext_info: bool + :keyword ignore_relationships: Whether to ignore relationship attributes. Default value is + None. + :paramtype ignore_relationships: bool + :return: AtlasEntityWithExtInfo. The AtlasEntityWithExtInfo is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntityWithExtInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "entity": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the + term assignment. + "createdBy": "str", # Optional. The user who created + the record. + "description": "str", # Optional. The description of + the term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms + assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", + "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of relationship. + }, + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the entity. + }, + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntityWithExtInfo] = kwargs.pop("cls", None) + + _request = build_entity_get_request( + guid=guid, + min_ext_info=min_ext_info, + ignore_relationships=ignore_relationships, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntityWithExtInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def update_attribute_by_id(self, guid: str, body: Any, *, name: str, **kwargs: Any) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Update entity partially - create or update entity attribute identified by its + GUID. + Supports only primitive attribute type and entity references. + It does not support updating complex types like arrays, and maps. + Null updates are not possible. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: The value of the attribute. Required. + :type body: any + :keyword name: The name of the attribute. Required. + :paramtype name: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: str = kwargs.pop("content_type", _headers.pop("Content-Type", "application/json")) + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_update_attribute_by_id_request( + guid=guid, + name=name, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete(self, guid: str, **kwargs: Any) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Delete an entity identified by its GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + _request = build_entity_delete_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_classification(self, guid: str, classification_name: str, **kwargs: Any) -> _models.AtlasClassification: + # pylint: disable=line-too-long + """Get classification for a given entity represented by a GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param classification_name: The name of the classification. Required. + :type classification_name: str + :return: AtlasClassification. The AtlasClassification is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasClassification + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time boundary. + "startTime": "str", # Optional. The start of the time + boundary. + "timeZone": "str" # Optional. The timezone of the time + boundary. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasClassification] = kwargs.pop("cls", None) + + _request = build_entity_get_classification_request( + guid=guid, + classification_name=classification_name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasClassification, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def remove_classification( # pylint: disable=inconsistent-return-statements + self, guid: str, classification_name: str, **kwargs: Any + ) -> None: + """Delete a given classification from an existing entity represented by a GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param classification_name: The name of the classification. Required. + :type classification_name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_entity_remove_classification_request( + guid=guid, + classification_name=classification_name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def get_classifications(self, guid: str, **kwargs: Any) -> _models.AtlasClassifications: + # pylint: disable=line-too-long + """List classifications for a given entity represented by a GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :return: AtlasClassifications. The AtlasClassifications is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasClassifications + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "list": [ + {} # Optional. An array of objects. + ], + "pageSize": 0, # Optional. The size of the page. + "sortBy": "str", # Optional. The sorted by field. + "sortType": "str", # Optional. to specify whether the result should be + sorted? If yes, whether asc or desc. Known values are: "NONE", "ASC", and "DESC". + "startIndex": 0, # Optional. The start index of the page. + "totalCount": 0 # Optional. The total count of items. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasClassifications] = kwargs.pop("cls", None) + + _request = build_entity_get_classifications_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasClassifications, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def add_classifications( # pylint: disable=inconsistent-return-statements + self, + guid: str, + body: List[_models.AtlasClassification], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Add classifications to an existing entity represented by a GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: An array of classifications to be added. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time + boundary. + "startTime": "str", # Optional. The start of the + time boundary. + "timeZone": "str" # Optional. The timezone of the + time boundary. + } + ] + } + ] + """ + + @overload + def add_classifications( # pylint: disable=inconsistent-return-statements + self, guid: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Add classifications to an existing entity represented by a GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: An array of classifications to be added. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def add_classifications( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Union[List[_models.AtlasClassification], IO[bytes]], **kwargs: Any + ) -> None: + """Add classifications to an existing entity represented by a GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: An array of classifications to be added. Is either a [AtlasClassification] type or + a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_add_classifications_request( + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def update_classifications( # pylint: disable=inconsistent-return-statements + self, + guid: str, + body: List[_models.AtlasClassification], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Update classifications to an existing entity represented by a guid. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: An array of classifications to be updated. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time + boundary. + "startTime": "str", # Optional. The start of the + time boundary. + "timeZone": "str" # Optional. The timezone of the + time boundary. + } + ] + } + ] + """ + + @overload + def update_classifications( # pylint: disable=inconsistent-return-statements + self, guid: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Update classifications to an existing entity represented by a guid. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: An array of classifications to be updated. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def update_classifications( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Union[List[_models.AtlasClassification], IO[bytes]], **kwargs: Any + ) -> None: + """Update classifications to an existing entity represented by a guid. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: An array of classifications to be updated. Is either a [AtlasClassification] type + or a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_update_classifications_request( + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def get_by_unique_attribute( + self, + type_name: str, + *, + min_ext_info: Optional[bool] = None, + ignore_relationships: Optional[bool] = None, + attribute: Optional[str] = None, + **kwargs: Any + ) -> _models.AtlasEntityWithExtInfo: + # pylint: disable=line-too-long + """Get complete definition of an entity given its type and unique attribute. + + In + addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the following format: + attr:\:code:``=:code:``. + + NOTE: The + attrName and attrValue should be unique across entities, eg. + qualifiedName. + + The REST request would look something like this: + GET + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :keyword min_ext_info: Whether to return minimal information for referred entities. Default + value is None. + :paramtype min_ext_info: bool + :keyword ignore_relationships: Whether to ignore relationship attributes. Default value is + None. + :paramtype ignore_relationships: bool + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: AtlasEntityWithExtInfo. The AtlasEntityWithExtInfo is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntityWithExtInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "entity": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the + term assignment. + "createdBy": "str", # Optional. The user who created + the record. + "description": "str", # Optional. The description of + the term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms + assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", + "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of relationship. + }, + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the entity. + }, + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntityWithExtInfo] = kwargs.pop("cls", None) + + _request = build_entity_get_by_unique_attribute_request( + type_name=type_name, + min_ext_info=min_ext_info, + ignore_relationships=ignore_relationships, + attribute=attribute, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntityWithExtInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def update_by_unique_attribute( + self, + type_name: str, + body: _models.AtlasEntityWithExtInfo, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Update entity partially - Allow a subset of attributes to be updated on an + entity which is identified by its type and unique attribute eg: + Referenceable.qualifiedName. Null updates are not possible. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: + + attr::code:``=:code:``. + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: + PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasEntityWithExtInfo + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entity": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the + term assignment. + "createdBy": "str", # Optional. The user who created + the record. + "description": "str", # Optional. The description of + the term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms + assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", + "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of relationship. + }, + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the entity. + }, + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + def update_by_unique_attribute( + self, + type_name: str, + body: JSON, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Update entity partially - Allow a subset of attributes to be updated on an + entity which is identified by its type and unique attribute eg: + Referenceable.qualifiedName. Null updates are not possible. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: + + attr::code:``=:code:``. + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: + PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: Required. + :type body: JSON + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + def update_by_unique_attribute( + self, + type_name: str, + body: IO[bytes], + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Update entity partially - Allow a subset of attributes to be updated on an + entity which is identified by its type and unique attribute eg: + Referenceable.qualifiedName. Null updates are not possible. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: + + attr::code:``=:code:``. + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: + PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: Required. + :type body: IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @distributed_trace + def update_by_unique_attribute( + self, + type_name: str, + body: Union[_models.AtlasEntityWithExtInfo, JSON, IO[bytes]], + *, + attribute: Optional[str] = None, + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Update entity partially - Allow a subset of attributes to be updated on an + entity which is identified by its type and unique attribute eg: + Referenceable.qualifiedName. Null updates are not possible. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: + + attr::code:``=:code:``. + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: + PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: Is one of the following types: AtlasEntityWithExtInfo, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasEntityWithExtInfo or JSON or IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entity": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the + term assignment. + "createdBy": "str", # Optional. The user who created + the record. + "description": "str", # Optional. The description of + the term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms + assignment. Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", + "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of relationship. + }, + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the entity. + }, + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_update_by_unique_attribute_request( + type_name=type_name, + attribute=attribute, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete_by_unique_attribute( + self, type_name: str, *, attribute: Optional[str] = None, **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Delete an entity identified by its type and unique attributes. + In addition to + the typeName path parameter, attribute key-value pair(s) can be provided in the + following format: + attr:\:code:``=\:code:``. + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: + DELETE + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + _request = build_entity_delete_by_unique_attribute_request( + type_name=type_name, + attribute=attribute, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def remove_classification_by_unique_attribute( # pylint: disable=inconsistent-return-statements,name-too-long + self, type_name: str, classification_name: str, *, attribute: Optional[str] = None, **kwargs: Any + ) -> None: + """Delete a given classification from an entity identified by its type and unique + attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param classification_name: The name of the classification. Required. + :type classification_name: str + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_entity_remove_classification_by_unique_attribute_request( + type_name=type_name, + classification_name=classification_name, + attribute=attribute, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def add_classifications_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: List[_models.AtlasClassification], + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Add classification to the entity identified by its type and unique attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: An array of classification to be added. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time + boundary. + "startTime": "str", # Optional. The start of the + time boundary. + "timeZone": "str" # Optional. The timezone of the + time boundary. + } + ] + } + ] + """ + + @overload + def add_classifications_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: IO[bytes], + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add classification to the entity identified by its type and unique attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: An array of classification to be added. Required. + :type body: IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def add_classifications_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Union[List[_models.AtlasClassification], IO[bytes]], + *, + attribute: Optional[str] = None, + **kwargs: Any + ) -> None: + """Add classification to the entity identified by its type and unique attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: An array of classification to be added. Is either a [AtlasClassification] type or + a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] or IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_add_classifications_by_unique_attribute_request( + type_name=type_name, + attribute=attribute, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def update_classifications_unique_by_attribute( # pylint: disable=inconsistent-return-statements,name-too-long + self, + type_name: str, + body: List[_models.AtlasClassification], + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Update classification on an entity identified by its type and unique attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: An array of classification to be updated. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "removePropagationsOnEntityDelete": bool, # Optional. Determines if + propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the time + boundary. + "startTime": "str", # Optional. The start of the + time boundary. + "timeZone": "str" # Optional. The timezone of the + time boundary. + } + ] + } + ] + """ + + @overload + def update_classifications_unique_by_attribute( # pylint: disable=inconsistent-return-statements,name-too-long + self, + type_name: str, + body: IO[bytes], + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Update classification on an entity identified by its type and unique attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: An array of classification to be updated. Required. + :type body: IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def update_classifications_unique_by_attribute( # pylint: disable=inconsistent-return-statements,name-too-long + self, + type_name: str, + body: Union[List[_models.AtlasClassification], IO[bytes]], + *, + attribute: Optional[str] = None, + **kwargs: Any + ) -> None: + """Update classification on an entity identified by its type and unique attributes. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: An array of classification to be updated. Is either a [AtlasClassification] type + or a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasClassification] or IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_update_classifications_unique_by_attribute_request( + type_name=type_name, + attribute=attribute, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def batch_set_classifications( + self, body: _models.AtlasEntityHeaders, *, content_type: str = "application/json", **kwargs: Any + ) -> List[str]: + # pylint: disable=line-too-long + """Set classifications on entities in bulk. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasEntityHeaders + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: list of str + :rtype: list[str] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "guidHeaderMap": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + } + } + + # response body for status code(s): 200 + response == [ + "str" # Optional. + ] + """ + + @overload + def batch_set_classifications( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> List[str]: + """Set classifications on entities in bulk. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: list of str + :rtype: list[str] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + "str" # Optional. + ] + """ + + @overload + def batch_set_classifications( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> List[str]: + """Set classifications on entities in bulk. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: list of str + :rtype: list[str] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + "str" # Optional. + ] + """ + + @distributed_trace + def batch_set_classifications( + self, body: Union[_models.AtlasEntityHeaders, JSON, IO[bytes]], **kwargs: Any + ) -> List[str]: + # pylint: disable=line-too-long + """Set classifications on entities in bulk. + + :param body: Is one of the following types: AtlasEntityHeaders, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasEntityHeaders or JSON or IO[bytes] + :return: list of str + :rtype: list[str] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "guidHeaderMap": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + } + } + + # response body for status code(s): 200 + response == [ + "str" # Optional. + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[List[str]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_batch_set_classifications_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[str], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def batch_get_by_unique_attributes( + self, + type_name: str, + *, + min_ext_info: Optional[bool] = None, + ignore_relationships: Optional[bool] = None, + attr_n_qualified_name: Optional[str] = None, + **kwargs: Any + ) -> _models.AtlasEntitiesWithExtInfo: + # pylint: disable=line-too-long + """Bulk API to retrieve list of entities identified by its unique attributes. + In + addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the following + format + + typeName=\:code:``&attr_1:\:code:``=\:code:``&attr_2:\:code:``=\:code:``&attr_3:\:code:``=\:code:`` + + NOTE: + The attrName should be an unique attribute for the given entity-type. + The REST + request would look something like this + + GET + /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 + + Note: + at least one unique attribute must be provided. + + :param type_name: The name of the type. Required. + :type type_name: str + :keyword min_ext_info: Whether to return minimal information for referred entities. Default + value is None. + :paramtype min_ext_info: bool + :keyword ignore_relationships: Whether to ignore relationship attributes. Default value is + None. + :paramtype ignore_relationships: bool + :keyword attr_n_qualified_name: Qualified name of an entity. E.g. to find 2 entities you can + set + attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an + example. qualifiedName can be changed to other unique attributes). Default value is None. + :paramtype attr_n_qualified_name: str + :return: AtlasEntitiesWithExtInfo. The AtlasEntitiesWithExtInfo is compatible with + MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntitiesWithExtInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "entities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + ], + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "businessAttributes": { + "str": {} # Optional. Business attributes. + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "collectionId": "str", # Optional. The collection ID of the + entity. + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "customAttributes": { + "str": "str" # Optional. Custom Attribute. + }, + "guid": "str", # Optional. The GUID of the entity. + "homeId": "str", # Optional. The home ID of the entity. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "provenanceType": 0, # Optional. Used to record the + provenance of an instance of an entity or relationship. + "proxy": bool, # Optional. Determines if there's a proxy. + "relationshipAttributes": { + "str": {} # Optional. The attributes of + relationship. + }, + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the entity. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntitiesWithExtInfo] = kwargs.pop("cls", None) + + _request = build_entity_batch_get_by_unique_attributes_request( + type_name=type_name, + min_ext_info=min_ext_info, + ignore_relationships=ignore_relationships, + attr_n_qualified_name=attr_n_qualified_name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntitiesWithExtInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_header(self, guid: str, **kwargs: Any) -> _models.AtlasEntityHeader: + # pylint: disable=line-too-long + """Get entity header given its GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :return: AtlasEntityHeader. The AtlasEntityHeader is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntityHeader + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence of the term + assignment. + "createdBy": "str", # Optional. The user who created the + record. + "description": "str", # Optional. The description of the + term assignment. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term + assignment. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of terms assignment. + Known values are: "DISCOVERED", "PROPOSED", "IMPORTED", "VALIDATED", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - can be active or + deleted. Deleted entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "typeName": "str" # Optional. The name of the type. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntityHeader] = kwargs.pop("cls", None) + + _request = build_entity_get_header_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntityHeader, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def remove_business_metadata( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Dict[str, Dict[str, Any]], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Remove business metadata from an entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata payload. Required. + :type body: dict[str, dict[str, any]] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": { + "str": {} # Optional. + } + } + """ + + @overload + def remove_business_metadata( # pylint: disable=inconsistent-return-statements + self, guid: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Remove business metadata from an entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata payload. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def remove_business_metadata( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Union[Dict[str, Dict[str, Any]], IO[bytes]], **kwargs: Any + ) -> None: + """Remove business metadata from an entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata payload. Is either a {str: {str: Any}} type or a IO[bytes] type. + Required. + :type body: dict[str, dict[str, any]] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_remove_business_metadata_request( + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def add_or_update_business_metadata( # pylint: disable=inconsistent-return-statements + self, + guid: str, + body: Dict[str, Dict[str, Any]], + *, + overwrite: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add business metadata to an entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: BusinessMetadata payload. Required. + :type body: dict[str, dict[str, any]] + :keyword overwrite: Whether to overwrite the existing business metadata on the entity or not, + default is false. Default value is None. + :paramtype overwrite: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": { + "str": {} # Optional. + } + } + """ + + @overload + def add_or_update_business_metadata( # pylint: disable=inconsistent-return-statements + self, + guid: str, + body: IO[bytes], + *, + overwrite: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add business metadata to an entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: BusinessMetadata payload. Required. + :type body: IO[bytes] + :keyword overwrite: Whether to overwrite the existing business metadata on the entity or not, + default is false. Default value is None. + :paramtype overwrite: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def add_or_update_business_metadata( # pylint: disable=inconsistent-return-statements + self, + guid: str, + body: Union[Dict[str, Dict[str, Any]], IO[bytes]], + *, + overwrite: Optional[bool] = None, + **kwargs: Any + ) -> None: + """Add business metadata to an entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: BusinessMetadata payload. Is either a {str: {str: Any}} type or a IO[bytes] type. + Required. + :type body: dict[str, dict[str, any]] or IO[bytes] + :keyword overwrite: Whether to overwrite the existing business metadata on the entity or not, + default is false. Default value is None. + :paramtype overwrite: bool + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_add_or_update_business_metadata_request( + guid=guid, + overwrite=overwrite, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def remove_business_metadata_attributes( # pylint: disable=inconsistent-return-statements + self, + business_metadata_name: str, + guid: str, + body: Dict[str, Any], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Delete business metadata attributes from an entity. + + :param business_metadata_name: BusinessMetadata name. Required. + :type business_metadata_name: str + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata attribute payload. Required. + :type body: dict[str, any] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": {} # Optional. + } + """ + + @overload + def remove_business_metadata_attributes( # pylint: disable=inconsistent-return-statements + self, + business_metadata_name: str, + guid: str, + body: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Delete business metadata attributes from an entity. + + :param business_metadata_name: BusinessMetadata name. Required. + :type business_metadata_name: str + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata attribute payload. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def remove_business_metadata_attributes( # pylint: disable=inconsistent-return-statements + self, business_metadata_name: str, guid: str, body: Union[Dict[str, Any], IO[bytes]], **kwargs: Any + ) -> None: + """Delete business metadata attributes from an entity. + + :param business_metadata_name: BusinessMetadata name. Required. + :type business_metadata_name: str + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata attribute payload. Is either a {str: Any} type or a IO[bytes] + type. Required. + :type body: dict[str, any] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_remove_business_metadata_attributes_request( + business_metadata_name=business_metadata_name, + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def add_or_update_business_metadata_attributes( # pylint: disable=inconsistent-return-statements,name-too-long + self, + business_metadata_name: str, + guid: str, + body: Dict[str, Any], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add or update business metadata attributes. + + :param business_metadata_name: BusinessMetadata name. Required. + :type business_metadata_name: str + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata attribute payload. Required. + :type body: dict[str, any] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": {} # Optional. + } + """ + + @overload + def add_or_update_business_metadata_attributes( # pylint: disable=inconsistent-return-statements,name-too-long + self, + business_metadata_name: str, + guid: str, + body: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add or update business metadata attributes. + + :param business_metadata_name: BusinessMetadata name. Required. + :type business_metadata_name: str + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata attribute payload. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def add_or_update_business_metadata_attributes( # pylint: disable=inconsistent-return-statements,name-too-long + self, business_metadata_name: str, guid: str, body: Union[Dict[str, Any], IO[bytes]], **kwargs: Any + ) -> None: + """Add or update business metadata attributes. + + :param business_metadata_name: BusinessMetadata name. Required. + :type business_metadata_name: str + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: Business metadata attribute payload. Is either a {str: Any} type or a IO[bytes] + type. Required. + :type body: dict[str, any] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_add_or_update_business_metadata_attributes_request( + business_metadata_name=business_metadata_name, + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def get_business_metadata_template(self, **kwargs: Any) -> bytes: + """Get the sample Template for uploading/creating bulk BusinessMetaData. + + :return: bytes + :rtype: bytes + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[bytes] = kwargs.pop("cls", None) + + _request = build_entity_get_business_metadata_template_request( + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", True) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + response.read() + deserialized = response.content + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def import_business_metadata(self, body: JSON, **kwargs: Any) -> _models.BulkImportResult: + """Upload the file for creating Business Metadata in BULK. + + :param body: Required. + :type body: JSON + :return: BulkImportResult. The BulkImportResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.BulkImportResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "file": bytes("bytes", encoding="utf-8") # InputStream of file. Required. + } + + # response body for status code(s): 200 + response == { + "failedImportInfoList": [ + { + "childObjectName": "str", # Optional. childObjectName. + "importStatus": "str", # Optional. importStatus. Known + values are: "SUCCESS" and "FAILED". + "parentObjectName": "str", # Optional. parentObjectName. + "remarks": "str" # Optional. remarks. + } + ], + "successImportInfoList": [ + { + "childObjectName": "str", # Optional. childObjectName. + "importStatus": "str", # Optional. importStatus. Known + values are: "SUCCESS" and "FAILED". + "parentObjectName": "str", # Optional. parentObjectName. + "remarks": "str" # Optional. remarks. + } + ] + } + """ + + @overload + def import_business_metadata(self, *, file: bytes, **kwargs: Any) -> _models.BulkImportResult: + """Upload the file for creating Business Metadata in BULK. + + :keyword file: InputStream of file. Required. + :paramtype file: bytes + :return: BulkImportResult. The BulkImportResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.BulkImportResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "failedImportInfoList": [ + { + "childObjectName": "str", # Optional. childObjectName. + "importStatus": "str", # Optional. importStatus. Known + values are: "SUCCESS" and "FAILED". + "parentObjectName": "str", # Optional. parentObjectName. + "remarks": "str" # Optional. remarks. + } + ], + "successImportInfoList": [ + { + "childObjectName": "str", # Optional. childObjectName. + "importStatus": "str", # Optional. importStatus. Known + values are: "SUCCESS" and "FAILED". + "parentObjectName": "str", # Optional. parentObjectName. + "remarks": "str" # Optional. remarks. + } + ] + } + """ + + @distributed_trace + def import_business_metadata( + self, body: JSON = _Unset, *, file: bytes = _Unset, **kwargs: Any + ) -> _models.BulkImportResult: + """Upload the file for creating Business Metadata in BULK. + + :param body: Is one of the following types: JSON Required. + :type body: JSON + :keyword file: InputStream of file. Required. + :paramtype file: bytes + :return: BulkImportResult. The BulkImportResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.BulkImportResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "file": bytes("bytes", encoding="utf-8") # InputStream of file. Required. + } + + # response body for status code(s): 200 + response == { + "failedImportInfoList": [ + { + "childObjectName": "str", # Optional. childObjectName. + "importStatus": "str", # Optional. importStatus. Known + values are: "SUCCESS" and "FAILED". + "parentObjectName": "str", # Optional. parentObjectName. + "remarks": "str" # Optional. remarks. + } + ], + "successImportInfoList": [ + { + "childObjectName": "str", # Optional. childObjectName. + "importStatus": "str", # Optional. importStatus. Known + values are: "SUCCESS" and "FAILED". + "parentObjectName": "str", # Optional. parentObjectName. + "remarks": "str" # Optional. remarks. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.BulkImportResult] = kwargs.pop("cls", None) + + if body is _Unset: + if file is _Unset: + raise TypeError("missing required argument: file") + body = {"file": file} + body = {k: v for k, v in body.items() if v is not None} + content_type = content_type or "multipart/form-data" + _content = None + if isinstance(body, MutableMapping): + _content = body + elif isinstance(body, MutableMapping): + _content = body + + _request = build_entity_import_business_metadata_request( + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.BulkImportResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def remove_labels( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[List[str]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Delete given labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be deleted. Default value is None. + :type body: list[str] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + "str" # Optional. + ] + """ + + @overload + def remove_labels( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Delete given labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be deleted. Default value is None. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def remove_labels( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[Union[List[str], IO[bytes]]] = None, **kwargs: Any + ) -> None: + """Delete given labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be deleted. Is either a [str] type or a IO[bytes] type. Default + value is None. + :type body: list[str] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + _request = build_entity_remove_labels_request( + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def set_labels( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[List[str]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Set labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be set to the entity. Default value is None. + :type body: list[str] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + "str" # Optional. + ] + """ + + @overload + def set_labels( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Set labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be set to the entity. Default value is None. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def set_labels( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[Union[List[str], IO[bytes]]] = None, **kwargs: Any + ) -> None: + """Set labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be set to the entity. Is either a [str] type or a IO[bytes] type. + Default value is None. + :type body: list[str] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + _request = build_entity_set_labels_request( + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def add_label( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[List[str]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Add given labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be added. Default value is None. + :type body: list[str] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + "str" # Optional. + ] + """ + + @overload + def add_label( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Add given labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be added. Default value is None. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def add_label( # pylint: disable=inconsistent-return-statements + self, guid: str, body: Optional[Union[List[str], IO[bytes]]] = None, **kwargs: Any + ) -> None: + """Add given labels to a given entity. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :param body: set of labels to be added. Is either a [str] type or a IO[bytes] type. Default + value is None. + :type body: list[str] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + _request = build_entity_add_label_request( + guid=guid, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[List[str]] = None, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Delete given labels to a given entity identified by its type and unique + attribute. + + If labels is null/empty, no labels will be removed. + + If any labels + in labels set are non-existing labels, they will be ignored, only existing + labels will be removed. In addition to the typeName path parameter, attribute + key-value pair(s) can be provided in the following format: + attr::code:``=:code:``. NOTE: The attrName and attrValue should be unique + across entities, eg. qualifiedName. The REST request would look something like + this: DELETE + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be deleted. Default value is None. + :type body: list[str] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + "str" # Optional. + ] + """ + + @overload + def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[IO[bytes]] = None, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Delete given labels to a given entity identified by its type and unique + attribute. + + If labels is null/empty, no labels will be removed. + + If any labels + in labels set are non-existing labels, they will be ignored, only existing + labels will be removed. In addition to the typeName path parameter, attribute + key-value pair(s) can be provided in the following format: + attr::code:``=:code:``. NOTE: The attrName and attrValue should be unique + across entities, eg. qualifiedName. The REST request would look something like + this: DELETE + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be deleted. Default value is None. + :type body: IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[Union[List[str], IO[bytes]]] = None, + *, + attribute: Optional[str] = None, + **kwargs: Any + ) -> None: + """Delete given labels to a given entity identified by its type and unique + attribute. + + If labels is null/empty, no labels will be removed. + + If any labels + in labels set are non-existing labels, they will be ignored, only existing + labels will be removed. In addition to the typeName path parameter, attribute + key-value pair(s) can be provided in the following format: + attr::code:``=:code:``. NOTE: The attrName and attrValue should be unique + across entities, eg. qualifiedName. The REST request would look something like + this: DELETE + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be deleted. Is either a [str] type or a IO[bytes] type. Default + value is None. + :type body: list[str] or IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + _request = build_entity_remove_labels_by_unique_attribute_request( + type_name=type_name, + attribute=attribute, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[List[str]] = None, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Set labels to a given entity identified by its type and unique attributes. + + If + labels is null/empty, existing labels will all be removed. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr::code:``=:code:``. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: POST + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be set. Default value is None. + :type body: list[str] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + "str" # Optional. + ] + """ + + @overload + def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[IO[bytes]] = None, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Set labels to a given entity identified by its type and unique attributes. + + If + labels is null/empty, existing labels will all be removed. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr::code:``=:code:``. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: POST + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be set. Default value is None. + :type body: IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[Union[List[str], IO[bytes]]] = None, + *, + attribute: Optional[str] = None, + **kwargs: Any + ) -> None: + """Set labels to a given entity identified by its type and unique attributes. + + If + labels is null/empty, existing labels will all be removed. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr::code:``=:code:``. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: POST + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be set. Is either a [str] type or a IO[bytes] type. Default value + is None. + :type body: list[str] or IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + _request = build_entity_set_labels_by_unique_attribute_request( + type_name=type_name, + attribute=attribute, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[List[str]] = None, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add given labels to a given entity identified by its type and unique + attributes. + + If labels is null/empty, no labels will be added. + + In addition to + the typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr::code:``=:code:``. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be added. Default value is None. + :type body: list[str] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + "str" # Optional. + ] + """ + + @overload + def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[IO[bytes]] = None, + *, + attribute: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Add given labels to a given entity identified by its type and unique + attributes. + + If labels is null/empty, no labels will be added. + + In addition to + the typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr::code:``=:code:``. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be added. Default value is None. + :type body: IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return-statements + self, + type_name: str, + body: Optional[Union[List[str], IO[bytes]]] = None, + *, + attribute: Optional[str] = None, + **kwargs: Any + ) -> None: + """Add given labels to a given entity identified by its type and unique + attributes. + + If labels is null/empty, no labels will be added. + + In addition to + the typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr::code:``=:code:``. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :param body: set of labels to be added. Is either a [str] type or a IO[bytes] type. Default + value is None. + :type body: list[str] or IO[bytes] + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + _request = build_entity_add_labels_by_unique_attribute_request( + type_name=type_name, + attribute=attribute, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def move_entities_to_collection( + self, + body: _models.MoveEntitiesOptions, + *, + collection_id: str, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Move existing entities to the target collection. + + :param body: Required. + :type body: ~azure.purview.datamap.models.MoveEntitiesOptions + :keyword collection_id: The collection where entities will be moved to. Required. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entityGuids": [ + "str" # Optional. An array of entity guids to be moved to target + collection. + ] + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + def move_entities_to_collection( + self, body: JSON, *, collection_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Move existing entities to the target collection. + + :param body: Required. + :type body: JSON + :keyword collection_id: The collection where entities will be moved to. Required. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @overload + def move_entities_to_collection( + self, body: IO[bytes], *, collection_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Move existing entities to the target collection. + + :param body: Required. + :type body: IO[bytes] + :keyword collection_id: The collection where entities will be moved to. Required. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + + @distributed_trace + def move_entities_to_collection( + self, body: Union[_models.MoveEntitiesOptions, JSON, IO[bytes]], *, collection_id: str, **kwargs: Any + ) -> _models.EntityMutationResult: + # pylint: disable=line-too-long + """Move existing entities to the target collection. + + :param body: Is one of the following types: MoveEntitiesOptions, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.MoveEntitiesOptions or JSON or IO[bytes] + :keyword collection_id: The collection where entities will be moved to. Required. + :paramtype collection_id: str + :return: EntityMutationResult. The EntityMutationResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.EntityMutationResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "entityGuids": [ + "str" # Optional. An array of entity guids to be moved to target + collection. + ] + } + + # response body for status code(s): 200 + response == { + "guidAssignments": { + "str": "str" # Optional. A map of GUID assignments with entities. + }, + "mutatedEntities": { + "str": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification + names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "entityGuid": "str", # Optional. The + GUID of the entity. + "entityStatus": "str", # Optional. + Status of the entity - can be active or deleted. Deleted + entities are not removed. Known values are: "ACTIVE" and + "DELETED". + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "removePropagationsOnEntityDelete": + bool, # Optional. Determines if propagations will be removed + on entity deletion. + "typeName": "str", # Optional. The + name of the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", + # Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a + shell entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The + confidence of the term assignment. + "createdBy": "str", # Optional. The + user who created the record. + "description": "str", # Optional. + The description of the term assignment. + "displayText": "str", # Optional. + The display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. + The GUID of the relationship. + "status": "str", # Optional. The + status of terms assignment. Known values are: "DISCOVERED", + "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The + steward of the term. + "termGuid": "str" # Optional. The + GUID of the term. + } + ], + "status": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + }, + "partialUpdatedEntities": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.EntityMutationResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_entity_move_entities_to_collection_request( + collection_id=collection_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.EntityMutationResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + +class GlossaryOperations: # pylint: disable=too-many-public-methods + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.purview.datamap.DataMapClient`'s + :attr:`glossary` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + def batch_get( + self, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + ignore_terms_and_categories: Optional[bool] = None, + **kwargs: Any + ) -> List[_models.AtlasGlossary]: + # pylint: disable=line-too-long + """Get all glossaries. Recommend using limit/offset to get pagination result. + Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories + separately using + + 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' + and + + 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'. + + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :return: list of AtlasGlossary + :rtype: list[~azure.purview.datamap.models.AtlasGlossary] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasGlossary]] = kwargs.pop("cls", None) + + _request = build_glossary_batch_get_request( + limit=limit, + offset=offset, + sort=sort, + ignore_terms_and_categories=ignore_terms_and_categories, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasGlossary], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create( + self, body: _models.AtlasGlossary, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Create a glossary. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasGlossary + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @overload + def create(self, body: JSON, *, content_type: str = "application/json", **kwargs: Any) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Create a glossary. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @overload + def create( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Create a glossary. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @distributed_trace + def create(self, body: Union[_models.AtlasGlossary, JSON, IO[bytes]], **kwargs: Any) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Create a glossary. + + :param body: Is one of the following types: AtlasGlossary, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasGlossary or JSON or IO[bytes] + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossary] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_create_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossary, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_categories( + self, body: List[_models.AtlasGlossaryCategory], *, content_type: str = "application/json", **kwargs: Any + ) -> List[_models.AtlasGlossaryCategory]: + # pylint: disable=line-too-long + """Create glossary category in bulk. + + :param body: An array of glossary category definitions to be created. Required. + :type body: list[~azure.purview.datamap.models.AtlasGlossaryCategory] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: list of AtlasGlossaryCategory + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryCategory] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + ] + + # response body for status code(s): 200 + response == [ + { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + ] + """ + + @overload + def create_categories( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> List[_models.AtlasGlossaryCategory]: + # pylint: disable=line-too-long + """Create glossary category in bulk. + + :param body: An array of glossary category definitions to be created. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: list of AtlasGlossaryCategory + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryCategory] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + ] + """ + + @distributed_trace + def create_categories( + self, body: Union[List[_models.AtlasGlossaryCategory], IO[bytes]], **kwargs: Any + ) -> List[_models.AtlasGlossaryCategory]: + # pylint: disable=line-too-long + """Create glossary category in bulk. + + :param body: An array of glossary category definitions to be created. Is either a + [AtlasGlossaryCategory] type or a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasGlossaryCategory] or IO[bytes] + :return: list of AtlasGlossaryCategory + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryCategory] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[List[_models.AtlasGlossaryCategory]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_create_categories_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasGlossaryCategory], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_category( + self, body: _models.AtlasGlossaryCategory, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Create a glossary category. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryCategory + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @overload + def create_category( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Create a glossary category. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @overload + def create_category( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Create a glossary category. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @distributed_trace + def create_category( + self, body: Union[_models.AtlasGlossaryCategory, JSON, IO[bytes]], **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Create a glossary category. + + :param body: Is one of the following types: AtlasGlossaryCategory, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryCategory or JSON or IO[bytes] + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossaryCategory] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_create_category_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryCategory, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_category(self, category_id: str, **kwargs: Any) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Get specific glossary category by its GUID. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasGlossaryCategory] = kwargs.pop("cls", None) + + _request = build_glossary_get_category_request( + category_id=category_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryCategory, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def update_category( + self, + category_id: str, + body: _models.AtlasGlossaryCategory, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the given glossary category by its GUID. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryCategory + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @overload + def update_category( + self, category_id: str, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the given glossary category by its GUID. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @overload + def update_category( + self, category_id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the given glossary category by its GUID. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @distributed_trace + def update_category( + self, category_id: str, body: Union[_models.AtlasGlossaryCategory, JSON, IO[bytes]], **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the given glossary category by its GUID. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: Is one of the following types: AtlasGlossaryCategory, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryCategory or JSON or IO[bytes] + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossaryCategory] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_update_category_request( + category_id=category_id, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryCategory, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete_category( # pylint: disable=inconsistent-return-statements + self, category_id: str, **kwargs: Any + ) -> None: + """Delete a glossary category. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_glossary_delete_category_request( + category_id=category_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def partial_update_category( + self, category_id: str, body: Dict[str, str], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the glossary category partially. So far we only supports partial + updating shortDescription and longDescription for category. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values for partial update. Required. + :type body: dict[str, str] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": "str" # Optional. + } + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @overload + def partial_update_category( + self, category_id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the glossary category partially. So far we only supports partial + updating shortDescription and longDescription for category. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values for partial update. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + + @distributed_trace + def partial_update_category( + self, category_id: str, body: Union[Dict[str, str], IO[bytes]], **kwargs: Any + ) -> _models.AtlasGlossaryCategory: + # pylint: disable=line-too-long + """Update the glossary category partially. So far we only supports partial + updating shortDescription and longDescription for category. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values for partial update. Is either a {str: str} type or a IO[bytes] type. Required. + :type body: dict[str, str] or IO[bytes] + :return: AtlasGlossaryCategory. The AtlasGlossaryCategory is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryCategory + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossaryCategory] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_partial_update_category_request( + category_id=category_id, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryCategory, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_related_categories( + self, + category_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> Dict[str, List[_models.AtlasRelatedCategoryHeader]]: + """Get all related categories (parent and children). Limit, offset, and sort + parameters are currently not being enabled and won't work even they are passed. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: dict mapping str to list of AtlasRelatedCategoryHeader + :rtype: dict[str, list[~azure.purview.datamap.models.AtlasRelatedCategoryHeader]] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "str": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[Dict[str, List[_models.AtlasRelatedCategoryHeader]]] = kwargs.pop("cls", None) + + _request = build_glossary_get_related_categories_request( + category_id=category_id, + limit=limit, + offset=offset, + sort=sort, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(Dict[str, List[_models.AtlasRelatedCategoryHeader]], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_category_terms( + self, + category_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> List[_models.AtlasRelatedTermHeader]: + # pylint: disable=line-too-long + """Get all terms associated with the specific category. + + :param category_id: The globally unique identifier of the category. Required. + :type category_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: list of AtlasRelatedTermHeader + :rtype: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "description": "str", # Optional. The description of the related + term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the relationship. + "status": "str", # Optional. The status of term relationship. Known + values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasRelatedTermHeader]] = kwargs.pop("cls", None) + + _request = build_glossary_get_category_terms_request( + category_id=category_id, + limit=limit, + offset=offset, + sort=sort, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasRelatedTermHeader], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_term( + self, + body: _models.AtlasGlossaryTerm, + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Create a glossary term. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryTerm + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @overload + def create_term( + self, + body: JSON, + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Create a glossary term. + + :param body: Required. + :type body: JSON + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @overload + def create_term( + self, + body: IO[bytes], + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Create a glossary term. + + :param body: Required. + :type body: IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @distributed_trace + def create_term( + self, + body: Union[_models.AtlasGlossaryTerm, JSON, IO[bytes]], + *, + include_term_hierarchy: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Create a glossary term. + + :param body: Is one of the following types: AtlasGlossaryTerm, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryTerm or JSON or IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossaryTerm] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_create_term_request( + include_term_hierarchy=include_term_hierarchy, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryTerm, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_term(self, term_id: str, **kwargs: Any) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Get a specific glossary term by its GUID. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasGlossaryTerm] = kwargs.pop("cls", None) + + _request = build_glossary_get_term_request( + term_id=term_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryTerm, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def update_term( + self, + term_id: str, + body: _models.AtlasGlossaryTerm, + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the given glossary term by its GUID. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryTerm + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @overload + def update_term( + self, + term_id: str, + body: JSON, + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the given glossary term by its GUID. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: Required. + :type body: JSON + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @overload + def update_term( + self, + term_id: str, + body: IO[bytes], + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the given glossary term by its GUID. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: Required. + :type body: IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @distributed_trace + def update_term( + self, + term_id: str, + body: Union[_models.AtlasGlossaryTerm, JSON, IO[bytes]], + *, + include_term_hierarchy: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the given glossary term by its GUID. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: Is one of the following types: AtlasGlossaryTerm, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasGlossaryTerm or JSON or IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossaryTerm] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_update_term_request( + term_id=term_id, + include_term_hierarchy=include_term_hierarchy, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryTerm, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete_term(self, term_id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete a glossary term. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_glossary_delete_term_request( + term_id=term_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def partial_update_term( + self, + term_id: str, + body: Dict[str, str], + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the glossary term partially. So far we only supports partial updating + shortDescription, longDescription, abbreviation, usage and status for term. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values to be updated. Required. + :type body: dict[str, str] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": "str" # Optional. + } + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @overload + def partial_update_term( + self, + term_id: str, + body: IO[bytes], + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the glossary term partially. So far we only supports partial updating + shortDescription, longDescription, abbreviation, usage and status for term. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values to be updated. Required. + :type body: IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + + @distributed_trace + def partial_update_term( + self, + term_id: str, + body: Union[Dict[str, str], IO[bytes]], + *, + include_term_hierarchy: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasGlossaryTerm: + # pylint: disable=line-too-long + """Update the glossary term partially. So far we only supports partial updating + shortDescription, longDescription, abbreviation, usage and status for term. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values to be updated. Is either a {str: str} type or a IO[bytes] type. Required. + :type body: dict[str, str] or IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :return: AtlasGlossaryTerm. The AtlasGlossaryTerm is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryTerm + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the + relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the term, + which is map>. The key of the first layer map + is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term relationship. + Known values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and + "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active Directory + object Id. + "info": "str" # Optional. additional information to + describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "replacedBy": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known values + are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossaryTerm] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_partial_update_term_request( + term_id=term_id, + include_term_hierarchy=include_term_hierarchy, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryTerm, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_terms( + self, + body: List[_models.AtlasGlossaryTerm], + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> List[_models.AtlasGlossaryTerm]: + # pylint: disable=line-too-long + """Create glossary terms in bulk. + + :param body: An array of glossary term definitions to be created in bulk. Required. + :type body: list[~azure.purview.datamap.models.AtlasGlossaryTerm] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: list of AtlasGlossaryTerm + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryTerm] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "typeName": "str" # Optional. The name of + the type. + }, + "relationshipGuid": "str", # Optional. The GUID of + the relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship + type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the + term, which is map>. The key of the first + layer map is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of + :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "replacedBy": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for + url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of + description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known + values are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + ] + + # response body for status code(s): 200 + response == [ + { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "typeName": "str" # Optional. The name of + the type. + }, + "relationshipGuid": "str", # Optional. The GUID of + the relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship + type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the + term, which is map>. The key of the first + layer map is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of + :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "replacedBy": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for + url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of + description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known + values are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + ] + """ + + @overload + def create_terms( + self, + body: IO[bytes], + *, + include_term_hierarchy: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> List[_models.AtlasGlossaryTerm]: + # pylint: disable=line-too-long + """Create glossary terms in bulk. + + :param body: An array of glossary term definitions to be created in bulk. Required. + :type body: IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: list of AtlasGlossaryTerm + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryTerm] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "typeName": "str" # Optional. The name of + the type. + }, + "relationshipGuid": "str", # Optional. The GUID of + the relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship + type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the + term, which is map>. The key of the first + layer map is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of + :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "replacedBy": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for + url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of + description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known + values are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + ] + """ + + @distributed_trace + def create_terms( + self, + body: Union[List[_models.AtlasGlossaryTerm], IO[bytes]], + *, + include_term_hierarchy: Optional[bool] = None, + **kwargs: Any + ) -> List[_models.AtlasGlossaryTerm]: + # pylint: disable=line-too-long + """Create glossary terms in bulk. + + :param body: An array of glossary term definitions to be created in bulk. Is either a + [AtlasGlossaryTerm] type or a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasGlossaryTerm] or IO[bytes] + :keyword include_term_hierarchy: Whether include term hierarchy. Default value is None. + :paramtype include_term_hierarchy: bool + :return: list of AtlasGlossaryTerm + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryTerm] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "typeName": "str" # Optional. The name of + the type. + }, + "relationshipGuid": "str", # Optional. The GUID of + the relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship + type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the + term, which is map>. The key of the first + layer map is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of + :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "replacedBy": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for + url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of + description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known + values are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[List[_models.AtlasGlossaryTerm]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_create_terms_request( + include_term_hierarchy=include_term_hierarchy, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasGlossaryTerm], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_entities_assigned_with_term( + self, + term_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> List[_models.AtlasRelatedObjectId]: + # pylint: disable=line-too-long + """List all related objects assigned with the specified term. Recommend using + limit/offset to get pagination result. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: list of AtlasRelatedObjectId + :rtype: list[~azure.purview.datamap.models.AtlasRelatedObjectId] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the relationship. + "relationshipStatus": "str", # Optional. The enum of relationship + status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasRelatedObjectId]] = kwargs.pop("cls", None) + + _request = build_glossary_get_entities_assigned_with_term_request( + term_id=term_id, + limit=limit, + offset=offset, + sort=sort, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasRelatedObjectId], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def assign_term_to_entities( # pylint: disable=inconsistent-return-statements + self, + term_id: str, + body: List[_models.AtlasRelatedObjectId], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Assign the given term to the provided list of related objects. Recommend using + small batches with multiple API calls. + + `Entities Create Or Update + operation + `_ + is an alternative to assign a term to multiple entities. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: An array of related object IDs to which the term has to be associated. Required. + :type body: list[~azure.purview.datamap.models.AtlasRelatedObjectId] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the relationship. + "relationshipStatus": "str", # Optional. The enum of relationship + status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + } + ] + """ + + @overload + def assign_term_to_entities( # pylint: disable=inconsistent-return-statements + self, term_id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Assign the given term to the provided list of related objects. Recommend using + small batches with multiple API calls. + + `Entities Create Or Update + operation + `_ + is an alternative to assign a term to multiple entities. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: An array of related object IDs to which the term has to be associated. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def assign_term_to_entities( # pylint: disable=inconsistent-return-statements + self, term_id: str, body: Union[List[_models.AtlasRelatedObjectId], IO[bytes]], **kwargs: Any + ) -> None: + """Assign the given term to the provided list of related objects. Recommend using + small batches with multiple API calls. + + `Entities Create Or Update + operation + `_ + is an alternative to assign a term to multiple entities. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: An array of related object IDs to which the term has to be associated. Is either a + [AtlasRelatedObjectId] type or a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasRelatedObjectId] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_assign_term_to_entities_request( + term_id=term_id, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def delete_term_assignment_from_entities( # pylint: disable=inconsistent-return-statements + self, + term_id: str, + body: List[_models.AtlasRelatedObjectId], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Delete the term assignment for the given list of related objects. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: An array of related object IDs from which the term has to be dissociated. + Required. + :type body: list[~azure.purview.datamap.models.AtlasRelatedObjectId] + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "typeName": "str" # Optional. The name of the type. + }, + "relationshipGuid": "str", # Optional. The GUID of the relationship. + "relationshipStatus": "str", # Optional. The enum of relationship + status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + } + ] + """ + + @overload + def delete_term_assignment_from_entities( # pylint: disable=inconsistent-return-statements + self, term_id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Delete the term assignment for the given list of related objects. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: An array of related object IDs from which the term has to be dissociated. + Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def delete_term_assignment_from_entities( # pylint: disable=inconsistent-return-statements + self, term_id: str, body: Union[List[_models.AtlasRelatedObjectId], IO[bytes]], **kwargs: Any + ) -> None: + """Delete the term assignment for the given list of related objects. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :param body: An array of related object IDs from which the term has to be dissociated. Is + either a [AtlasRelatedObjectId] type or a IO[bytes] type. Required. + :type body: list[~azure.purview.datamap.models.AtlasRelatedObjectId] or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_delete_term_assignment_from_entities_request( + term_id=term_id, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def get_related_terms( + self, + term_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> Dict[str, List[_models.AtlasRelatedTermHeader]]: + # pylint: disable=line-too-long + """Get all related terms for a specific term by its GUID. Limit, offset, and sort + parameters are currently not being enabled and won't work even they are passed. + + :param term_id: The globally unique identifier for glossary term. Required. + :type term_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: dict mapping str to list of AtlasRelatedTermHeader + :rtype: dict[str, list[~azure.purview.datamap.models.AtlasRelatedTermHeader]] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "str": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[Dict[str, List[_models.AtlasRelatedTermHeader]]] = kwargs.pop("cls", None) + + _request = build_glossary_get_related_terms_request( + term_id=term_id, + limit=limit, + offset=offset, + sort=sort, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(Dict[str, List[_models.AtlasRelatedTermHeader]], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get(self, glossary_id: str, **kwargs: Any) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Get a specific Glossary by its GUID. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasGlossary] = kwargs.pop("cls", None) + + _request = build_glossary_get_request( + glossary_id=glossary_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossary, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def update( + self, + glossary_id: str, + body: _models.AtlasGlossary, + *, + ignore_terms_and_categories: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the given glossary. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasGlossary + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @overload + def update( + self, + glossary_id: str, + body: JSON, + *, + ignore_terms_and_categories: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the given glossary. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: Required. + :type body: JSON + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @overload + def update( + self, + glossary_id: str, + body: IO[bytes], + *, + ignore_terms_and_categories: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the given glossary. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: Required. + :type body: IO[bytes] + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @distributed_trace + def update( + self, + glossary_id: str, + body: Union[_models.AtlasGlossary, JSON, IO[bytes]], + *, + ignore_terms_and_categories: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the given glossary. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: Is one of the following types: AtlasGlossary, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasGlossary or JSON or IO[bytes] + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossary] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_update_request( + glossary_id=glossary_id, + ignore_terms_and_categories=ignore_terms_and_categories, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossary, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete(self, glossary_id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete a glossary. Will delete underlying terms/categories together. Recommend + separate delete terms and categories. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_glossary_delete_request( + glossary_id=glossary_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def get_categories( + self, + glossary_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> List[_models.AtlasGlossaryCategory]: + # pylint: disable=line-too-long + """Get the categories belonging to a specific glossary. Recommend using + limit/offset to get pagination result. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: list of AtlasGlossaryCategory + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryCategory] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the record. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasGlossaryCategory]] = kwargs.pop("cls", None) + + _request = build_glossary_get_categories_request( + glossary_id=glossary_id, + limit=limit, + offset=offset, + sort=sort, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasGlossaryCategory], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_categories_headers( + self, + glossary_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> List[_models.AtlasRelatedCategoryHeader]: + """Get the category headers belonging to a specific glossary. Recommend using + limit/offset to get pagination result. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: list of AtlasRelatedCategoryHeader + :rtype: list[~azure.purview.datamap.models.AtlasRelatedCategoryHeader] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the category + header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the parent + category. + "relationGuid": "str" # Optional. The GUID of the relationship. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasRelatedCategoryHeader]] = kwargs.pop("cls", None) + + _request = build_glossary_get_categories_headers_request( + glossary_id=glossary_id, + limit=limit, + offset=offset, + sort=sort, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasRelatedCategoryHeader], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_detailed(self, glossary_id: str, **kwargs: Any) -> _models.AtlasGlossaryExtInfo: + # pylint: disable=line-too-long + """Get a specific glossary with detailed information. This API is not + recommend. + + Recommend to fetch terms/categories details separately using + + GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and + + GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :return: AtlasGlossaryExtInfo. The AtlasGlossaryExtInfo is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossaryExtInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "categoryInfo": { + "str": { + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the + glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "childrenCategories": [ + { + "categoryGuid": "str", # Optional. The GUID + of the category. + "description": "str", # Optional. The + description of the category header. + "displayText": "str", # Optional. The + display text. + "parentCategoryGuid": "str", # Optional. The + GUID of the parent category. + "relationGuid": "str" # Optional. The GUID + of the relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "guid": "str", # Optional. The GUID of the object. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "longDescription": "str", # Optional. The long version + description. + "name": "str", # Optional. The name of the glossary object. + "parentCategory": { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of + the parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "qualifiedName": "str", # Optional. The qualified name of + the glossary object. + "shortDescription": "str", # Optional. The short version of + description. + "terms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str" # Optional. The user who updated the + record. + } + }, + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "termInfo": { + "str": { + "abbreviation": "str", # Optional. The abbreviation of the + term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the + glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The + display text. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the + object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The + attributes of the struct. + }, + "lastModifiedTS": "str", # Optional. + ETag for concurrency control. + "typeName": "str" # Optional. The + name of the type. + }, + "relationshipGuid": "str", # Optional. The + GUID of the relationship. + "relationshipStatus": "str", # Optional. The + enum of relationship status. Known values are: "ACTIVE" and + "DELETED". + "relationshipType": "str", # Optional. + Relationship type. + "typeName": "str", # Optional. The name of + the type. + "uniqueAttributes": { + "str": {} # Optional. The unique + attributes of the object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes + of the term, which is map>. The key of + the first layer map is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID + of the category. + "description": "str", # Optional. The + description of the record. + "displayText": "str", # Optional. The + display text. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str" # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure + Active Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display + text. + "guid": "str", # Optional. The GUID of the + object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of + :code:``. + }, + "resourceId": "str", # Optional. Resource + Id. + "typeName": "str", # Optional. The name of + the type. + "uniqueAttributes": { + "str": {} # Optional. The unique + attributes of the object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "longDescription": "str", # Optional. The long version + description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of + the glossary object. + "replacedBy": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display + name for url. + "url": "str" # Optional. web url. http or + https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "shortDescription": "str", # Optional. The short version of + description. + "status": "str", # Optional. Status of the + AtlasGlossaryTerm. Known values are: "Draft", "Approved", "Alert", and + "Expired". + "synonyms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The + description of the related term. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + term relationship. Known values are: "DRAFT", "ACTIVE", + "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ] + } + }, + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasGlossaryExtInfo] = kwargs.pop("cls", None) + + _request = build_glossary_get_detailed_request( + glossary_id=glossary_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossaryExtInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def partial_update( + self, + glossary_id: str, + body: Dict[str, str], + *, + ignore_terms_and_categories: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the glossary partially. Some properties such as qualifiedName are not + allowed to be updated. + + So far we only supports partial updating + shortDescription, longDescription, language and usage for glossary. + + Recommend + using 'ignoreTermsAndCategories=true' to reduce response body size. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values. Required. + :type body: dict[str, str] + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "str": "str" # Optional. + } + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @overload + def partial_update( + self, + glossary_id: str, + body: IO[bytes], + *, + ignore_terms_and_categories: Optional[bool] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the glossary partially. Some properties such as qualifiedName are not + allowed to be updated. + + So far we only supports partial updating + shortDescription, longDescription, language and usage for glossary. + + Recommend + using 'ignoreTermsAndCategories=true' to reduce response body size. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values. Required. + :type body: IO[bytes] + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + + @distributed_trace + def partial_update( + self, + glossary_id: str, + body: Union[Dict[str, str], IO[bytes]], + *, + ignore_terms_and_categories: Optional[bool] = None, + **kwargs: Any + ) -> _models.AtlasGlossary: + # pylint: disable=line-too-long + """Update the glossary partially. Some properties such as qualifiedName are not + allowed to be updated. + + So far we only supports partial updating + shortDescription, longDescription, language and usage for glossary. + + Recommend + using 'ignoreTermsAndCategories=true' to reduce response body size. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :param body: A map containing keys as attribute names and values as corresponding attribute + values. Is either a {str: str} type or a IO[bytes] type. Required. + :type body: dict[str, str] or IO[bytes] + :keyword ignore_terms_and_categories: Whether ignore terms and categories. Default value is + None. + :paramtype ignore_terms_and_categories: bool + :return: AtlasGlossary. The AtlasGlossary is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasGlossary + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the category. + "description": "str", # Optional. The description of the + category header. + "displayText": "str", # Optional. The display text. + "parentCategoryGuid": "str", # Optional. The GUID of the + parent category. + "relationGuid": "str" # Optional. The GUID of the + relationship. + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "entityGuid": "str", # Optional. The GUID of the entity. + "entityStatus": "str", # Optional. Status of the entity - + can be active or deleted. Deleted entities are not removed. Known values + are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "removePropagationsOnEntityDelete": bool, # Optional. + Determines if propagations will be removed on entity deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The end of the + time boundary. + "startTime": "str", # Optional. The start of + the time boundary. + "timeZone": "str" # Optional. The timezone + of the time boundary. + } + ] + } + ], + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "guid": "str", # Optional. The GUID of the object. + "language": "str", # Optional. The language of the glossary. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "qualifiedName": "str", # Optional. The qualified name of the glossary + object. + "shortDescription": "str", # Optional. The short version of description. + "terms": [ + { + "description": "str", # Optional. The description of the + related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str" # Optional. The usage of the glossary. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasGlossary] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_glossary_partial_update_request( + glossary_id=glossary_id, + ignore_terms_and_categories=ignore_terms_and_categories, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasGlossary, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_terms( + self, + glossary_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> List[_models.AtlasGlossaryTerm]: + # pylint: disable=line-too-long + """Get terms belonging to a specific glossary. Recommend using limit/offset to get + pagination result. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: list of AtlasGlossaryTerm + :rtype: list[~azure.purview.datamap.models.AtlasGlossaryTerm] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "abbreviation": "str", # Optional. The abbreviation of the term. + "anchor": { + "displayText": "str", # Optional. The display text. + "glossaryGuid": "str", # Optional. The GUID of the glossary. + "relationGuid": "str" # Optional. The GUID of the + relationship. + }, + "antonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "assignedEntities": [ + { + "displayText": "str", # Optional. The display text. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "guid": "str", # Optional. The GUID of the object. + "relationshipAttributes": { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "typeName": "str" # Optional. The name of + the type. + }, + "relationshipGuid": "str", # Optional. The GUID of + the relationship. + "relationshipStatus": "str", # Optional. The enum of + relationship status. Known values are: "ACTIVE" and "DELETED". + "relationshipType": "str", # Optional. Relationship + type. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "attributes": { + "str": { + "str": {} # Optional. The custom attributes of the + term, which is map>. The key of the first + layer map is term template name. + } + }, + "categories": [ + { + "categoryGuid": "str", # Optional. The GUID of the + category. + "description": "str", # Optional. The description of + the record. + "displayText": "str", # Optional. The display text. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str" # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + } + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes of the + struct. + }, + "entityGuid": "str", # Optional. The GUID of the + entity. + "entityStatus": "str", # Optional. Status of the + entity - can be active or deleted. Deleted entities are not removed. + Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag for + concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of the type. + "validityPeriods": [ + { + "endTime": "str", # Optional. The + end of the time boundary. + "startTime": "str", # Optional. The + start of the time boundary. + "timeZone": "str" # Optional. The + timezone of the time boundary. + } + ] + } + ], + "classifies": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "contacts": { + "str": [ + { + "id": "str", # Optional. Azure Active + Directory object Id. + "info": "str" # Optional. additional + information to describe this contact. + } + ] + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "examples": [ + "str" # Optional. An array of examples. + ], + "guid": "str", # Optional. The GUID of the object. + "hierarchyInfo": [ + { + "displayText": "str", # Optional. Display text. + "guid": "str", # Optional. The GUID of the object. + "itemPath": "str", # Optional. Item path. + "name": "str", # Optional. Name. + "properties": { + "str": {} # Optional. Dictionary of + :code:``. + }, + "resourceId": "str", # Optional. Resource Id. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes + of the object. + } + } + ], + "isA": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "longDescription": "str", # Optional. The long version description. + "name": "str", # Optional. The name of the glossary object. + "nickName": "str", # Optional. The nick name of the term. + "preferredTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "preferredToTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "qualifiedName": "str", # Optional. The qualified name of the + glossary object. + "replacedBy": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "replacementTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "resources": [ + { + "displayName": "str", # Optional. Display name for + url. + "url": "str" # Optional. web url. http or https. + } + ], + "seeAlso": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "shortDescription": "str", # Optional. The short version of + description. + "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known + values are: "Draft", "Approved", "Alert", and "Expired". + "synonyms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "templateName": [ + {} # Optional. The name of the template. + ], + "translatedTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "translationTerms": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "usage": "str", # Optional. The usage of the term. + "validValues": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ], + "validValuesFor": [ + { + "description": "str", # Optional. The description of + the related term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of + the term. + "relationGuid": "str", # Optional. The GUID of the + relationship. + "status": "str", # Optional. The status of term + relationship. Known values are: "DRAFT", "ACTIVE", "DEPRECATED", + "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the + term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasGlossaryTerm]] = kwargs.pop("cls", None) + + _request = build_glossary_get_terms_request( + glossary_id=glossary_id, + limit=limit, + offset=offset, + sort=sort, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasGlossaryTerm], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_term_headers( + self, + glossary_id: str, + *, + limit: Optional[int] = None, + offset: Optional[int] = None, + sort: Optional[str] = None, + **kwargs: Any + ) -> List[_models.AtlasRelatedTermHeader]: + # pylint: disable=line-too-long + """Get term headers belonging to a specific glossary. Recommend using limit/offset + to get pagination result. + + :param glossary_id: The globally unique identifier for glossary. Required. + :type glossary_id: str + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword sort: The sort order, ASC (default) or DESC. Default value is None. + :paramtype sort: str + :return: list of AtlasRelatedTermHeader + :rtype: list[~azure.purview.datamap.models.AtlasRelatedTermHeader] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "description": "str", # Optional. The description of the related + term. + "displayText": "str", # Optional. The display text. + "expression": "str", # Optional. The expression of the term. + "relationGuid": "str", # Optional. The GUID of the relationship. + "status": "str", # Optional. The status of term relationship. Known + values are: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of the term. + "termGuid": "str" # Optional. The GUID of the term. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasRelatedTermHeader]] = kwargs.pop("cls", None) + + _request = build_glossary_get_term_headers_request( + glossary_id=glossary_id, + limit=limit, + offset=offset, + sort=sort, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasRelatedTermHeader], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + +class DiscoveryOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.purview.datamap.DataMapClient`'s + :attr:`discovery` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def query( + self, body: _models.QueryOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.QueryResult: + # pylint: disable=line-too-long + """Get data using search. + + :param body: Required. + :type body: ~azure.purview.datamap.models.QueryOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: QueryResult. The QueryResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.QueryResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "continuationToken": "str", # Optional. The token used to get next batch of + data. Default 'Null' to get the first batch, and will return new token in each + response unless there's no more data. + "facets": [ + { + "count": 0, # Optional. The count of the facet item. + "facet": "str", # Optional. The name of the facet item. + "sort": { + "count": "str", # Optional. Order by count. Known + values are: "asc" and "desc". + "value": "str" # Optional. Order by value. Known + values are: "asc" and "desc". + } + } + ], + "filter": {}, # Optional. The filter for the search. See examples for the + usage of supported filters. + "keywords": "str", # Optional. The keywords applied to all searchable + fields. + "limit": 0, # Optional. The limit of the number of the search result. + default value is 50; maximum value is 1000. + "orderby": [ + {} # Optional. The sort order of search results, can specify + multiple fields. + ], + "taxonomySetting": { + "assetTypes": [ + "str" # Optional. Asset types. + ], + "facet": { + "count": 0, # Optional. The count of the facet item. + "facet": "str", # Optional. The name of the facet item. + "sort": { + "count": "str", # Optional. Order by count. Known + values are: "asc" and "desc". + "value": "str" # Optional. Order by value. Known + values are: "asc" and "desc". + } + } + } + } + + # response body for status code(s): 200 + response == { + "@search.count": 0, # Optional. The total number of search results (not the + number of documents in a single page). + "@search.count.approximate": bool, # Optional. 'True' if the '@search.count' + is an approximate value and vise versa. + "@search.facets": { + "assetType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "classification": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactId": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "entityType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "glossaryType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "label": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "term": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termStatus": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termTemplate": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ] + }, + "continuationToken": "str", # Optional. The token used to get next batch of + data. Absent if there's no more data. + "value": [ + { + "@search.highlights": { + "description": [ + "str" # Optional. Description. + ], + "entityType": [ + "str" # Optional. Entity type. + ], + "id": [ + "str" # Optional. Id. + ], + "name": [ + "str" # Optional. Name. + ], + "qualifiedName": [ + "str" # Optional. Qualified name. + ] + }, + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + + @overload + def query(self, body: JSON, *, content_type: str = "application/json", **kwargs: Any) -> _models.QueryResult: + # pylint: disable=line-too-long + """Get data using search. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: QueryResult. The QueryResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.QueryResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "@search.count": 0, # Optional. The total number of search results (not the + number of documents in a single page). + "@search.count.approximate": bool, # Optional. 'True' if the '@search.count' + is an approximate value and vise versa. + "@search.facets": { + "assetType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "classification": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactId": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "entityType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "glossaryType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "label": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "term": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termStatus": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termTemplate": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ] + }, + "continuationToken": "str", # Optional. The token used to get next batch of + data. Absent if there's no more data. + "value": [ + { + "@search.highlights": { + "description": [ + "str" # Optional. Description. + ], + "entityType": [ + "str" # Optional. Entity type. + ], + "id": [ + "str" # Optional. Id. + ], + "name": [ + "str" # Optional. Name. + ], + "qualifiedName": [ + "str" # Optional. Qualified name. + ] + }, + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + + @overload + def query(self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any) -> _models.QueryResult: + # pylint: disable=line-too-long + """Get data using search. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: QueryResult. The QueryResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.QueryResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "@search.count": 0, # Optional. The total number of search results (not the + number of documents in a single page). + "@search.count.approximate": bool, # Optional. 'True' if the '@search.count' + is an approximate value and vise versa. + "@search.facets": { + "assetType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "classification": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactId": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "entityType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "glossaryType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "label": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "term": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termStatus": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termTemplate": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ] + }, + "continuationToken": "str", # Optional. The token used to get next batch of + data. Absent if there's no more data. + "value": [ + { + "@search.highlights": { + "description": [ + "str" # Optional. Description. + ], + "entityType": [ + "str" # Optional. Entity type. + ], + "id": [ + "str" # Optional. Id. + ], + "name": [ + "str" # Optional. Name. + ], + "qualifiedName": [ + "str" # Optional. Qualified name. + ] + }, + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + + @distributed_trace + def query(self, body: Union[_models.QueryOptions, JSON, IO[bytes]], **kwargs: Any) -> _models.QueryResult: + # pylint: disable=line-too-long + """Get data using search. + + :param body: Is one of the following types: QueryOptions, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.QueryOptions or JSON or IO[bytes] + :return: QueryResult. The QueryResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.QueryResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "continuationToken": "str", # Optional. The token used to get next batch of + data. Default 'Null' to get the first batch, and will return new token in each + response unless there's no more data. + "facets": [ + { + "count": 0, # Optional. The count of the facet item. + "facet": "str", # Optional. The name of the facet item. + "sort": { + "count": "str", # Optional. Order by count. Known + values are: "asc" and "desc". + "value": "str" # Optional. Order by value. Known + values are: "asc" and "desc". + } + } + ], + "filter": {}, # Optional. The filter for the search. See examples for the + usage of supported filters. + "keywords": "str", # Optional. The keywords applied to all searchable + fields. + "limit": 0, # Optional. The limit of the number of the search result. + default value is 50; maximum value is 1000. + "orderby": [ + {} # Optional. The sort order of search results, can specify + multiple fields. + ], + "taxonomySetting": { + "assetTypes": [ + "str" # Optional. Asset types. + ], + "facet": { + "count": 0, # Optional. The count of the facet item. + "facet": "str", # Optional. The name of the facet item. + "sort": { + "count": "str", # Optional. Order by count. Known + values are: "asc" and "desc". + "value": "str" # Optional. Order by value. Known + values are: "asc" and "desc". + } + } + } + } + + # response body for status code(s): 200 + response == { + "@search.count": 0, # Optional. The total number of search results (not the + number of documents in a single page). + "@search.count.approximate": bool, # Optional. 'True' if the '@search.count' + is an approximate value and vise versa. + "@search.facets": { + "assetType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "classification": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactId": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "contactType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "entityType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "glossaryType": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "label": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "term": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termStatus": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ], + "termTemplate": [ + { + "count": 0, # Optional. The count of the facet item. + "value": "str" # Optional. The name of the facet + item. + } + ] + }, + "continuationToken": "str", # Optional. The token used to get next batch of + data. Absent if there's no more data. + "value": [ + { + "@search.highlights": { + "description": [ + "str" # Optional. Description. + ], + "entityType": [ + "str" # Optional. Entity type. + ], + "id": [ + "str" # Optional. Id. + ], + "name": [ + "str" # Optional. Name. + ], + "qualifiedName": [ + "str" # Optional. Qualified name. + ] + }, + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.QueryResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_discovery_query_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.QueryResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def suggest( + self, body: _models.SuggestOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.SuggestResult: + # pylint: disable=line-too-long + """Get search suggestions by query criteria. + + :param body: Required. + :type body: ~azure.purview.datamap.models.SuggestOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SuggestResult. The SuggestResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.SuggestResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filter": {}, # Optional. The filter for the search. + "keywords": "str", # Optional. The keywords applied to all fields that + support suggest operation. It must be at least 1 character, and no more than 100 + characters. In the index schema we defined a default suggester which lists all + the supported fields and specifies a search mode. + "limit": 0 # Optional. The number of suggestions we hope to return. The + default value is 5. The value must be a number between 1 and 100. + } + + # response body for status code(s): 200 + response == { + "value": [ + { + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "@search.text": "str", # Optional. The target text that + contains the keyword as prefix. The keyword is wrapped with emphasis + mark. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + + @overload + def suggest(self, body: JSON, *, content_type: str = "application/json", **kwargs: Any) -> _models.SuggestResult: + # pylint: disable=line-too-long + """Get search suggestions by query criteria. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SuggestResult. The SuggestResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.SuggestResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "@search.text": "str", # Optional. The target text that + contains the keyword as prefix. The keyword is wrapped with emphasis + mark. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + + @overload + def suggest( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.SuggestResult: + # pylint: disable=line-too-long + """Get search suggestions by query criteria. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: SuggestResult. The SuggestResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.SuggestResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "@search.text": "str", # Optional. The target text that + contains the keyword as prefix. The keyword is wrapped with emphasis + mark. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + + @distributed_trace + def suggest(self, body: Union[_models.SuggestOptions, JSON, IO[bytes]], **kwargs: Any) -> _models.SuggestResult: + # pylint: disable=line-too-long + """Get search suggestions by query criteria. + + :param body: Is one of the following types: SuggestOptions, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.SuggestOptions or JSON or IO[bytes] + :return: SuggestResult. The SuggestResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.SuggestResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filter": {}, # Optional. The filter for the search. + "keywords": "str", # Optional. The keywords applied to all fields that + support suggest operation. It must be at least 1 character, and no more than 100 + characters. In the index schema we defined a default suggester which lists all + the supported fields and specifies a search mode. + "limit": 0 # Optional. The number of suggestions we hope to return. The + default value is 5. The value must be a number between 1 and 100. + } + + # response body for status code(s): 200 + response == { + "value": [ + { + "@search.score": 0.0, # Optional. The search score + calculated by the search engine. The results are ordered by search score + by default. + "@search.text": "str", # Optional. The target text that + contains the keyword as prefix. The keyword is wrapped with emphasis + mark. + "assetType": [ + "str" # Optional. The asset types of the asset. + ], + "classification": [ + "str" # Optional. The classifications of the record. + ], + "contact": [ + { + "contactType": "str", # Optional. The type + of the contact. It can be Expert or Owner for an entity. It can + be Expert or Steward for a glossary term. + "id": "str", # Optional. The GUID of the + contact. + "info": "str" # Optional. The description of + the contact. + } + ], + "createTime": 0, # Optional. The create time of the record. + The Unix epoch format. + "description": "str", # Optional. The description of the + asset. + "endorsement": "str", # Optional. The endorsement of the + asset. + "entityType": "str", # Optional. The type name of the asset. + "glossary": "str", # Optional. The glossary name of the + term. + "glossaryType": "str", # Optional. The type name of the + term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. + "id": "str", # Optional. The GUID of the record. + "label": [ + "str" # Optional. The labels of the asset. + ], + "longDescription": "str", # Optional. The definition of the + term. + "name": "str", # Optional. The name of the record. + "objectType": "str", # Optional. The object type of the + record. Object type is the top-level property to distinguish whether a + record is an asset or a term. + "owner": "str", # Optional. The owner of the record. + "qualifiedName": "str", # Optional. The qualified name of + the record. + "term": [ + { + "glossaryName": "str", # Optional. The name + of the glossary which contains the term. + "guid": "str", # Optional. The GUID of the + term. + "name": "str" # Optional. The name of the + term. + } + ], + "termStatus": "str", # Optional. The status of the term. + "termTemplate": [ + "str" # Optional. The term template names used by + the term. + ], + "updateTime": 0 # Optional. The last update time of the + record. The Unix epoch format. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.SuggestResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_discovery_suggest_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.SuggestResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def auto_complete( + self, body: _models.AutoCompleteOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AutoCompleteResult: + # pylint: disable=line-too-long + """Get auto complete options. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AutoCompleteOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AutoCompleteResult. The AutoCompleteResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AutoCompleteResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filter": {}, # Optional. The filter for the autocomplete request. + "keywords": "str", # Optional. The keywords applied to all fields that + support autocomplete operation. It must be at least 1 character, and no more than + 100 characters. + "limit": 0 # Optional. The number of autocomplete results we hope to return. + The default value is 50. The value must be a number between 1 and 100. + } + + # response body for status code(s): 200 + response == { + "value": [ + { + "queryPlusText": "str", # Optional. The completed search + query text. + "text": "str" # Optional. The completed term or phrase. + } + ] + } + """ + + @overload + def auto_complete( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AutoCompleteResult: + """Get auto complete options. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AutoCompleteResult. The AutoCompleteResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AutoCompleteResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "queryPlusText": "str", # Optional. The completed search + query text. + "text": "str" # Optional. The completed term or phrase. + } + ] + } + """ + + @overload + def auto_complete( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AutoCompleteResult: + """Get auto complete options. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AutoCompleteResult. The AutoCompleteResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AutoCompleteResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "queryPlusText": "str", # Optional. The completed search + query text. + "text": "str" # Optional. The completed term or phrase. + } + ] + } + """ + + @distributed_trace + def auto_complete( + self, body: Union[_models.AutoCompleteOptions, JSON, IO[bytes]], **kwargs: Any + ) -> _models.AutoCompleteResult: + # pylint: disable=line-too-long + """Get auto complete options. + + :param body: Is one of the following types: AutoCompleteOptions, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AutoCompleteOptions or JSON or IO[bytes] + :return: AutoCompleteResult. The AutoCompleteResult is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AutoCompleteResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filter": {}, # Optional. The filter for the autocomplete request. + "keywords": "str", # Optional. The keywords applied to all fields that + support autocomplete operation. It must be at least 1 character, and no more than + 100 characters. + "limit": 0 # Optional. The number of autocomplete results we hope to return. + The default value is 50. The value must be a number between 1 and 100. + } + + # response body for status code(s): 200 + response == { + "value": [ + { + "queryPlusText": "str", # Optional. The completed search + query text. + "text": "str" # Optional. The completed term or phrase. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AutoCompleteResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_discovery_auto_complete_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AutoCompleteResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + +class LineageOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.purview.datamap.DataMapClient`'s + :attr:`lineage` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + def get( + self, guid: str, *, direction: Union[str, _models.LineageDirection], depth: Optional[int] = None, **kwargs: Any + ) -> _models.AtlasLineageInfo: + # pylint: disable=line-too-long + """Get lineage info of the entity specified by GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :keyword direction: The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Known + values are: "INPUT", "OUTPUT", and "BOTH". Required. + :paramtype direction: str or ~azure.purview.datamap.models.LineageDirection + :keyword depth: The number of hops for lineage. Default value is None. + :paramtype depth: int + :return: AtlasLineageInfo. The AtlasLineageInfo is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasLineageInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "baseEntityGuid": "str", # Optional. The GUID of the base entity. + "childrenCount": 0, # Optional. The number of children node. + "guidEntityMap": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + }, + "lineageDepth": 0, # Optional. The depth of lineage. + "lineageDirection": "str", # Optional. The enum of lineage direction. Known + values are: "INPUT", "OUTPUT", and "BOTH". + "lineageWidth": 0, # Optional. The width of lineage. + "parentRelations": [ + { + "childEntityId": "str", # Optional. The GUID of child + entity. + "parentEntityId": "str", # Optional. The GUID of parent + entity. + "relationshipId": "str" # Optional. The GUID of + relationship. + } + ], + "relations": [ + { + "fromEntityId": "str", # Optional. The GUID of from-entity. + "relationshipId": "str", # Optional. The GUID of + relationship. + "toEntityId": "str" # Optional. The GUID of to-entity. + } + ], + "widthCounts": { + "str": { + "str": {} # Optional. The entity count in specific + direction. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasLineageInfo] = kwargs.pop("cls", None) + + _request = build_lineage_get_request( + guid=guid, + direction=direction, + depth=depth, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasLineageInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_next_page( + self, + guid: str, + *, + direction: Union[str, _models.LineageDirection], + offset: Optional[int] = None, + limit: Optional[int] = None, + **kwargs: Any + ) -> _models.AtlasLineageInfo: + # pylint: disable=line-too-long + """Return immediate next page lineage info about entity with pagination. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :keyword direction: The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Known + values are: "INPUT", "OUTPUT", and "BOTH". Required. + :paramtype direction: str or ~azure.purview.datamap.models.LineageDirection + :keyword offset: The offset for pagination purpose. Default value is None. + :paramtype offset: int + :keyword limit: The page size - by default there is no paging. Default value is None. + :paramtype limit: int + :return: AtlasLineageInfo. The AtlasLineageInfo is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasLineageInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "baseEntityGuid": "str", # Optional. The GUID of the base entity. + "childrenCount": 0, # Optional. The number of children node. + "guidEntityMap": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + }, + "lineageDepth": 0, # Optional. The depth of lineage. + "lineageDirection": "str", # Optional. The enum of lineage direction. Known + values are: "INPUT", "OUTPUT", and "BOTH". + "lineageWidth": 0, # Optional. The width of lineage. + "parentRelations": [ + { + "childEntityId": "str", # Optional. The GUID of child + entity. + "parentEntityId": "str", # Optional. The GUID of parent + entity. + "relationshipId": "str" # Optional. The GUID of + relationship. + } + ], + "relations": [ + { + "fromEntityId": "str", # Optional. The GUID of from-entity. + "relationshipId": "str", # Optional. The GUID of + relationship. + "toEntityId": "str" # Optional. The GUID of to-entity. + } + ], + "widthCounts": { + "str": { + "str": {} # Optional. The entity count in specific + direction. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasLineageInfo] = kwargs.pop("cls", None) + + _request = build_lineage_get_next_page_request( + guid=guid, + direction=direction, + offset=offset, + limit=limit, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasLineageInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_by_unique_attribute( + self, + type_name: str, + *, + direction: Union[str, _models.LineageDirection], + depth: Optional[int] = None, + attribute: Optional[str] = None, + **kwargs: Any + ) -> _models.AtlasLineageInfo: + # pylint: disable=line-too-long + """Return lineage info about entity. + + In addition to the typeName path parameter, + attribute key-value pair(s) can be provided in the following + format + + attr:[attrName]=[attrValue] + + NOTE: The attrName and attrValue should be + unique across entities, eg. qualifiedName. + + The REST request would look + something like this: + + GET + /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + + :param type_name: The name of the type. Required. + :type type_name: str + :keyword direction: The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Known + values are: "INPUT", "OUTPUT", and "BOTH". Required. + :paramtype direction: str or ~azure.purview.datamap.models.LineageDirection + :keyword depth: The number of hops for lineage. Default value is None. + :paramtype depth: int + :keyword attribute: The qualified name of the entity. (This is only an example. qualifiedName + can + be changed to other unique attributes). Default value is None. + :paramtype attribute: str + :return: AtlasLineageInfo. The AtlasLineageInfo is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasLineageInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "baseEntityGuid": "str", # Optional. The GUID of the base entity. + "childrenCount": 0, # Optional. The number of children node. + "guidEntityMap": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + }, + "lineageDepth": 0, # Optional. The depth of lineage. + "lineageDirection": "str", # Optional. The enum of lineage direction. Known + values are: "INPUT", "OUTPUT", and "BOTH". + "lineageWidth": 0, # Optional. The width of lineage. + "parentRelations": [ + { + "childEntityId": "str", # Optional. The GUID of child + entity. + "parentEntityId": "str", # Optional. The GUID of parent + entity. + "relationshipId": "str" # Optional. The GUID of + relationship. + } + ], + "relations": [ + { + "fromEntityId": "str", # Optional. The GUID of from-entity. + "relationshipId": "str", # Optional. The GUID of + relationship. + "toEntityId": "str" # Optional. The GUID of to-entity. + } + ], + "widthCounts": { + "str": { + "str": {} # Optional. The entity count in specific + direction. + } + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasLineageInfo] = kwargs.pop("cls", None) + + _request = build_lineage_get_by_unique_attribute_request( + type_name=type_name, + direction=direction, + depth=depth, + attribute=attribute, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasLineageInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + +class RelationshipOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.purview.datamap.DataMapClient`'s + :attr:`relationship` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def create( + self, body: _models.AtlasRelationship, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasRelationship: + """Create a new relationship between entities. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasRelationship + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + + @overload + def create(self, body: JSON, *, content_type: str = "application/json", **kwargs: Any) -> _models.AtlasRelationship: + """Create a new relationship between entities. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + + @overload + def create( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasRelationship: + """Create a new relationship between entities. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + + @distributed_trace + def create( + self, body: Union[_models.AtlasRelationship, JSON, IO[bytes]], **kwargs: Any + ) -> _models.AtlasRelationship: + """Create a new relationship between entities. + + :param body: Is one of the following types: AtlasRelationship, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasRelationship or JSON or IO[bytes] + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasRelationship] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_relationship_create_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasRelationship, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def update( + self, body: _models.AtlasRelationship, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasRelationship: + """Update an existing relationship between entities. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasRelationship + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + + @overload + def update(self, body: JSON, *, content_type: str = "application/json", **kwargs: Any) -> _models.AtlasRelationship: + """Update an existing relationship between entities. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + + @overload + def update( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasRelationship: + """Update an existing relationship between entities. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + + @distributed_trace + def update( + self, body: Union[_models.AtlasRelationship, JSON, IO[bytes]], **kwargs: Any + ) -> _models.AtlasRelationship: + """Update an existing relationship between entities. + + :param body: Is one of the following types: AtlasRelationship, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasRelationship or JSON or IO[bytes] + :return: AtlasRelationship. The AtlasRelationship is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationship + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + + # response body for status code(s): 200 + response == { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known values + are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasRelationship] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_relationship_update_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasRelationship, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get( + self, guid: str, *, extended_info: Optional[bool] = None, **kwargs: Any + ) -> _models.AtlasRelationshipWithExtInfo: + # pylint: disable=line-too-long + """Get relationship information between entities by its GUID. + + :param guid: The globally unique identifier of the relationship. Required. + :type guid: str + :keyword extended_info: Limits whether includes extended information. Default value is None. + :paramtype extended_info: bool + :return: AtlasRelationshipWithExtInfo. The AtlasRelationshipWithExtInfo is compatible with + MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationshipWithExtInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "referredEntities": { + "str": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "classificationNames": [ + "str" # Optional. An array of classification names. + ], + "classifications": [ + { + "attributes": { + "str": {} # Optional. The attributes + of the struct. + }, + "entityGuid": "str", # Optional. The GUID of + the entity. + "entityStatus": "str", # Optional. Status of + the entity - can be active or deleted. Deleted entities are not + removed. Known values are: "ACTIVE" and "DELETED". + "lastModifiedTS": "str", # Optional. ETag + for concurrency control. + "removePropagationsOnEntityDelete": bool, # + Optional. Determines if propagations will be removed on entity + deletion. + "typeName": "str", # Optional. The name of + the type. + "validityPeriods": [ + { + "endTime": "str", # + Optional. The end of the time boundary. + "startTime": "str", # + Optional. The start of the time boundary. + "timeZone": "str" # + Optional. The timezone of the time boundary. + } + ] + } + ], + "displayText": "str", # Optional. The display text. + "guid": "str", # Optional. The GUID of the record. + "isIncomplete": bool, # Optional. Whether it is a shell + entity. + "labels": [ + "str" # Optional. labels. + ], + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "meaningNames": [ + "str" # Optional. An array of meanings. + ], + "meanings": [ + { + "confidence": 0, # Optional. The confidence + of the term assignment. + "createdBy": "str", # Optional. The user who + created the record. + "description": "str", # Optional. The + description of the term assignment. + "displayText": "str", # Optional. The + display text. + "expression": "str", # Optional. The + expression of the term assignment. + "relationGuid": "str", # Optional. The GUID + of the relationship. + "status": "str", # Optional. The status of + terms assignment. Known values are: "DISCOVERED", "PROPOSED", + "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", and "OTHER". + "steward": "str", # Optional. The steward of + the term. + "termGuid": "str" # Optional. The GUID of + the term. + } + ], + "status": "str", # Optional. Status of the entity - can be + active or deleted. Deleted entities are not removed. Known values are: + "ACTIVE" and "DELETED". + "typeName": "str" # Optional. The name of the type. + } + }, + "relationship": { + "attributes": { + "str": {} # Optional. The attributes of the struct. + }, + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "end1": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + }, + "end2": { + "guid": "str", # Optional. The GUID of the object. + "typeName": "str", # Optional. The name of the type. + "uniqueAttributes": { + "str": {} # Optional. The unique attributes of the + object. + } + }, + "guid": "str", # Optional. The GUID of the relationship. + "homeId": "str", # Optional. The home ID of the relationship. + "label": "str", # Optional. The label of the relationship. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "provenanceType": 0, # Optional. Used to record the provenance of an + instance of an entity or relationship. + "status": "str", # Optional. The enum of relationship status. Known + values are: "ACTIVE" and "DELETED". + "typeName": "str", # Optional. The name of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the relationship. + } + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasRelationshipWithExtInfo] = kwargs.pop("cls", None) + + _request = build_relationship_get_request( + guid=guid, + extended_info=extended_info, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasRelationshipWithExtInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete(self, guid: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete a relationship between entities by its GUID. + + :param guid: The globally unique identifier of the relationship. Required. + :type guid: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_relationship_delete_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + +class TypeDefinitionOperations: # pylint: disable=too-many-public-methods + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.purview.datamap.DataMapClient`'s + :attr:`type_definition` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + def get_business_metadata_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasBusinessMetadataDef: + # pylint: disable=line-too-long + """Get the businessMetadata definition for the given guid. + + :param guid: businessMetadata guid. Required. + :type guid: str + :return: AtlasBusinessMetadataDef. The AtlasBusinessMetadataDef is compatible with + MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasBusinessMetadataDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasBusinessMetadataDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_business_metadata_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasBusinessMetadataDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_business_metadata_by_name(self, name: str, **kwargs: Any) -> _models.AtlasBusinessMetadataDef: + # pylint: disable=line-too-long + """Get the businessMetadata definition by it's name (unique). + + :param name: businessMetadata name. Required. + :type name: str + :return: AtlasBusinessMetadataDef. The AtlasBusinessMetadataDef is compatible with + MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasBusinessMetadataDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasBusinessMetadataDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_business_metadata_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasBusinessMetadataDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_classification_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasClassificationDef: + # pylint: disable=line-too-long + """Get the classification definition for the given GUID. + + :param guid: The globally unique identifier of the classification. Required. + :type guid: str + :return: AtlasClassificationDef. The AtlasClassificationDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasClassificationDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType names in the + classificationDef, ensures that classifications can only be applied to those + entityTypes. Any subtypes of the entity types inherit the restriction. Any + classificationDef subtypes inherit the parents entityTypes restrictions. Any + classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. An empty entityTypes + list when there are no parent restrictions means there are no restrictions. + An empty entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes are + supplied, where one inherits from another, this will be rejected. This should + encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasClassificationDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_classification_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasClassificationDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_classification_by_name(self, name: str, **kwargs: Any) -> _models.AtlasClassificationDef: + # pylint: disable=line-too-long + """Get the classification definition by its name (unique). + + :param name: The name of the classification. Required. + :type name: str + :return: AtlasClassificationDef. The AtlasClassificationDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasClassificationDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType names in the + classificationDef, ensures that classifications can only be applied to those + entityTypes. Any subtypes of the entity types inherit the restriction. Any + classificationDef subtypes inherit the parents entityTypes restrictions. Any + classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. An empty entityTypes + list when there are no parent restrictions means there are no restrictions. + An empty entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes are + supplied, where one inherits from another, this will be rejected. This should + encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasClassificationDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_classification_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasClassificationDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_entity_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEntityDef: + # pylint: disable=line-too-long + """Get the Entity definition for the given GUID. + + :param guid: The globally unique identifier of the entity. Required. + :type guid: str + :return: AtlasEntityDef. The AtlasEntityDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntityDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isLegacyAttribute": bool, # Optional. Determines if it is a + legacy attribute. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "relationshipTypeName": "str", # Optional. The name of the + relationship type. + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntityDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_entity_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntityDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_entity_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEntityDef: + # pylint: disable=line-too-long + """Get the entity definition by its name (unique). + + :param name: The name of the entity. Required. + :type name: str + :return: AtlasEntityDef. The AtlasEntityDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEntityDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isLegacyAttribute": bool, # Optional. Determines if it is a + legacy attribute. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "relationshipTypeName": "str", # Optional. The name of the + relationship type. + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEntityDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_entity_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEntityDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_enum_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEnumDef: + # pylint: disable=line-too-long + """Get the enum definition for the given GUID. + + :param guid: The globally unique identifier of the enum. Required. + :type guid: str + :return: AtlasEnumDef. The AtlasEnumDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEnumDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the type definition. + "elementDefs": [ + { + "description": "str", # Optional. The description of the + enum element definition. + "ordinal": 0, # Optional. The ordinal of the enum element + definition. + "value": "str" # Optional. The value of the enum element + definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEnumDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_enum_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEnumDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_enum_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEnumDef: + # pylint: disable=line-too-long + """Get the enum definition by its name (unique). + + :param name: The name of the enum. Required. + :type name: str + :return: AtlasEnumDef. The AtlasEnumDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasEnumDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the type definition. + "elementDefs": [ + { + "description": "str", # Optional. The description of the + enum element definition. + "ordinal": 0, # Optional. The ordinal of the enum element + definition. + "value": "str" # Optional. The value of the enum element + definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasEnumDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_enum_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasEnumDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_relationship_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasRelationshipDef: + # pylint: disable=line-too-long + """Get the relationship definition for the given GUID. + + :param guid: The globally unique identifier of the relationship. Required. + :type guid: str + :return: AtlasRelationshipDef. The AtlasRelationshipDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationshipDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "relationshipCategory": "str", # Optional. The Relationship category + determines the style of relationship around containment and lifecycle. UML + terminology is used for the values. ASSOCIATION is a relationship with no + containment. COMPOSITION and AGGREGATION are containment relationships. The + difference being in the lifecycles of the container and its children. In the + COMPOSITION case, the children cannot exist without the container. For + AGGREGATION, the life cycles of the container and children are totally + independent. Known values are: "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasRelationshipDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_relationship_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasRelationshipDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_relationship_by_name(self, name: str, **kwargs: Any) -> _models.AtlasRelationshipDef: + # pylint: disable=line-too-long + """Get the relationship definition by its name (unique). + + :param name: The name of the relationship. Required. + :type name: str + :return: AtlasRelationshipDef. The AtlasRelationshipDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasRelationshipDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "relationshipCategory": "str", # Optional. The Relationship category + determines the style of relationship around containment and lifecycle. UML + terminology is used for the values. ASSOCIATION is a relationship with no + containment. COMPOSITION and AGGREGATION are containment relationships. The + difference being in the lifecycles of the container and its children. In the + COMPOSITION case, the children cannot exist without the container. For + AGGREGATION, the life cycles of the container and children are totally + independent. Known values are: "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasRelationshipDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_relationship_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasRelationshipDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_struct_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasStructDef: + # pylint: disable=line-too-long + """Get the struct definition for the given GUID. + + :param guid: The globally unique identifier of the struct. Required. + :type guid: str + :return: AtlasStructDef. The AtlasStructDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasStructDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasStructDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_struct_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasStructDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_struct_by_name(self, name: str, **kwargs: Any) -> _models.AtlasStructDef: + # pylint: disable=line-too-long + """Get the struct definition by its name (unique). + + :param name: The name of the struct. Required. + :type name: str + :return: AtlasStructDef. The AtlasStructDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasStructDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasStructDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_struct_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasStructDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasTypeDef: + # pylint: disable=line-too-long + """Get the type definition for the given GUID. + + :param guid: The globally unique identifier of the type. Required. + :type guid: str + :return: AtlasTypeDef. The AtlasTypeDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypeDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the type definition. + "elementDefs": [ + { + "description": "str", # Optional. The description of the + enum element definition. + "ordinal": 0, # Optional. The ordinal of the enum element + definition. + "value": "str" # Optional. The value of the enum element + definition. + } + ], + "endDef1": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "entityTypes": [ + "str" # Optional. Specifying a list of entityType names in the + classificationDef, ensures that classifications can only be applied to those + entityTypes. Any subtypes of the entity types inherit the restriction. Any + classificationDef subtypes inherit the parents entityTypes restrictions. Any + classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. An empty entityTypes + list when there are no parent restrictions means there are no restrictions. + An empty entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes are + supplied, where one inherits from another, this will be rejected. This should + encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isLegacyAttribute": bool, # Optional. Determines if it is a + legacy attribute. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "relationshipTypeName": "str", # Optional. The name of the + relationship type. + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "relationshipCategory": "str", # Optional. The Relationship category + determines the style of relationship around containment and lifecycle. UML + terminology is used for the values. ASSOCIATION is a relationship with no + containment. COMPOSITION and AGGREGATION are containment relationships. The + difference being in the lifecycles of the container and its children. In the + COMPOSITION case, the children cannot exist without the container. For + AGGREGATION, the life cycles of the container and children are totally + independent. Known values are: "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the relationship. + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasTypeDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_by_id_request( + guid=guid, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasTypeDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_by_name(self, name: str, **kwargs: Any) -> _models.AtlasTypeDef: + # pylint: disable=line-too-long + """Get the type definition by its name (unique). + + :param name: The name of the type. Required. + :type name: str + :return: AtlasTypeDef. The AtlasTypeDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypeDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the type definition. + "elementDefs": [ + { + "description": "str", # Optional. The description of the + enum element definition. + "ordinal": 0, # Optional. The ordinal of the enum element + definition. + "value": "str" # Optional. The value of the enum element + definition. + } + ], + "endDef1": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "description": "str", # Optional. The description of the + relationship end definition. + "isContainer": bool, # Optional. Determines if it is container. + "isLegacyAttribute": bool, # Optional. Determines if it is a legacy + attribute. + "name": "str", # Optional. The name of the relationship end + definition. + "type": "str" # Optional. The type of the relationship end. + }, + "entityTypes": [ + "str" # Optional. Specifying a list of entityType names in the + classificationDef, ensures that classifications can only be applied to those + entityTypes. Any subtypes of the entity types inherit the restriction. Any + classificationDef subtypes inherit the parents entityTypes restrictions. Any + classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. An empty entityTypes + list when there are no parent restrictions means there are no restrictions. + An empty entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes are + supplied, where one inherits from another, this will be rejected. This should + encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isLegacyAttribute": bool, # Optional. Determines if it is a + legacy attribute. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "relationshipTypeName": "str", # Optional. The name of the + relationship type. + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "relationshipCategory": "str", # Optional. The Relationship category + determines the style of relationship around containment and lifecycle. UML + terminology is used for the values. ASSOCIATION is a relationship with no + containment. COMPOSITION and AGGREGATION are containment relationships. The + difference being in the lifecycles of the container and its children. In the + COMPOSITION case, the children cannot exist without the container. For + AGGREGATION, the life cycles of the container and children are totally + independent. Known values are: "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the relationship. + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasTypeDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_by_name_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasTypeDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete(self, name: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete API for type identified by its name. + + :param name: The name of the type. Required. + :type name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_type_definition_delete_request( + name=name, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def get( + self, + *, + include_term_template: Optional[bool] = None, + type: Optional[Union[str, _models.TypeCategory]] = None, + **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """List all type definitions in bulk. + + :keyword include_term_template: Whether include termtemplatedef when return all typedefs. + This is always true + when search filter type=term_template. Default value is None. + :paramtype include_term_template: bool + :keyword type: Typedef name as search filter when get typedefs. Known values are: "PRIMITIVE", + "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", + and "TERM_TEMPLATE". Default value is None. + :paramtype type: str or ~azure.purview.datamap.models.TypeCategory + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AtlasTypesDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_request( + include_term_template=include_term_template, + type=type, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasTypesDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def batch_create( + self, body: _models.AtlasTypesDef, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Create all atlas type definitions in bulk, only new definitions will be + created. + Any changes to the existing definitions will be discarded. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasTypesDef + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @overload + def batch_create( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Create all atlas type definitions in bulk, only new definitions will be + created. + Any changes to the existing definitions will be discarded. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @overload + def batch_create( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Create all atlas type definitions in bulk, only new definitions will be + created. + Any changes to the existing definitions will be discarded. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @distributed_trace + def batch_create(self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kwargs: Any) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Create all atlas type definitions in bulk, only new definitions will be + created. + Any changes to the existing definitions will be discarded. + + :param body: Is one of the following types: AtlasTypesDef, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasTypesDef or JSON or IO[bytes] + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasTypesDef] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_type_definition_batch_create_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasTypesDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def batch_update( + self, body: _models.AtlasTypesDef, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Update all types in bulk, changes detected in the type definitions would be + persisted. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasTypesDef + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @overload + def batch_update( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Update all types in bulk, changes detected in the type definitions would be + persisted. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @overload + def batch_update( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Update all types in bulk, changes detected in the type definitions would be + persisted. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @distributed_trace + def batch_update(self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kwargs: Any) -> _models.AtlasTypesDef: + # pylint: disable=line-too-long + """Update all types in bulk, changes detected in the type definitions would be + persisted. + + :param body: Is one of the following types: AtlasTypesDef, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasTypesDef or JSON or IO[bytes] + :return: AtlasTypesDef. The AtlasTypesDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.AtlasTypesDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + + # response body for status code(s): 200 + response == { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AtlasTypesDef] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_type_definition_batch_update_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AtlasTypesDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def batch_delete( # pylint: disable=inconsistent-return-statements + self, body: _models.AtlasTypesDef, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Delete API for all types in bulk. + + :param body: Required. + :type body: ~azure.purview.datamap.models.AtlasTypesDef + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + + @overload + def batch_delete( # pylint: disable=inconsistent-return-statements + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Delete API for all types in bulk. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def batch_delete( # pylint: disable=inconsistent-return-statements + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Delete API for all types in bulk. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def batch_delete( # pylint: disable=inconsistent-return-statements + self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Delete API for all types in bulk. + + :param body: Is one of the following types: AtlasTypesDef, JSON, IO[bytes] Required. + :type body: ~azure.purview.datamap.models.AtlasTypesDef or JSON or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "businessMetadataDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "classificationDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "entityTypes": [ + "str" # Optional. Specifying a list of entityType + names in the classificationDef, ensures that classifications can only + be applied to those entityTypes. Any subtypes of the entity types + inherit the restriction. Any classificationDef subtypes inherit the + parents entityTypes restrictions. Any classificationDef subtypes can + further restrict the parents entityTypes restrictions by specifying a + subset of the entityTypes. An empty entityTypes list when there are + no parent restrictions means there are no restrictions. An empty + entityTypes list when there are parent restrictions means that the + subtype picks up the parents restrictions. If a list of entityTypes + are supplied, where one inherits from another, this will be rejected. + This should encourage cleaner classificationsDefs. + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "entityDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipAttributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isLegacyAttribute": bool, # Optional. + Determines if it is a legacy attribute. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "relationshipTypeName": "str", # Optional. + The name of the relationship type. + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "serviceType": "str", # Optional. The service type. + "subTypes": [ + "str" # Optional. An array of sub types. + ], + "superTypes": [ + "str" # Optional. An array of super types. + ], + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "enumDefs": [ + { + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "defaultValue": "str", # Optional. The default value. + "description": "str", # Optional. The description of the + type definition. + "elementDefs": [ + { + "description": "str", # Optional. The + description of the enum element definition. + "ordinal": 0, # Optional. The ordinal of the + enum element definition. + "value": "str" # Optional. The value of the + enum element definition. + } + ], + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "relationshipDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "endDef1": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "endDef2": { + "cardinality": "str", # Optional. single-valued + attribute or multi-valued attribute. Known values are: "SINGLE", + "LIST", and "SET". + "description": "str", # Optional. The description of + the relationship end definition. + "isContainer": bool, # Optional. Determines if it is + container. + "isLegacyAttribute": bool, # Optional. Determines if + it is a legacy attribute. + "name": "str", # Optional. The name of the + relationship end definition. + "type": "str" # Optional. The type of the + relationship end. + }, + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "relationshipCategory": "str", # Optional. The Relationship + category determines the style of relationship around containment and + lifecycle. UML terminology is used for the values. ASSOCIATION is a + relationship with no containment. COMPOSITION and AGGREGATION are + containment relationships. The difference being in the lifecycles of the + container and its children. In the COMPOSITION case, the children cannot + exist without the container. For AGGREGATION, the life cycles of the + container and children are totally independent. Known values are: + "ASSOCIATION", "AGGREGATION", and "COMPOSITION". + "relationshipLabel": "str", # Optional. The label of the + relationship. + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "structDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ], + "termTemplateDefs": [ + { + "attributeDefs": [ + { + "cardinality": "str", # Optional. + single-valued attribute or multi-valued attribute. Known values + are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # + Optional. The parameters of the constraint + definition. + }, + "type": "str" # Optional. + The type of the constraint. + } + ], + "defaultValue": "str", # Optional. The + default value of the attribute. + "description": "str", # Optional. The + description of the attribute. + "includeInNotification": bool, # Optional. + Determines if it is included in notification. + "isIndexable": bool, # Optional. Determines + if it is indexable. + "isOptional": bool, # Optional. Determines + if it is optional. + "isUnique": bool, # Optional. Determines if + it unique. + "name": "str", # Optional. The name of the + attribute. + "options": { + "str": "str" # Optional. The options + for the attribute. + }, + "typeName": "str", # Optional. The name of + the type. + "valuesMaxCount": 0, # Optional. The maximum + count of the values. + "valuesMinCount": 0 # Optional. The minimum + count of the values. + } + ], + "category": "str", # Optional. The enum of type category. + Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the + record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available + locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency + of the date format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines + if grouping is used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The + maximum of fraction digits. + "maximumIntegerDigits": 0, # Optional. The + maximum of integer digits. + "minimumFractionDigits": 0, # Optional. The + minimum of fraction digits. + "minimumIntegerDigits": 0, # Optional. The + minimum of integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. + Determines if only integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum + of rounding mode. Known values are: "UP", "DOWN", "CEILING", + "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of + available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The + display name of the timezone. + "dstSavings": 0, # Optional. The value of + the daylight saving time. + "id": "str", # Optional. The ID of the + timezone. + "rawOffset": 0 # Optional. The raw offset of + the timezone. + } + }, + "description": "str", # Optional. The description of the + type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency + control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type + definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the + record. + "version": 0 # Optional. The version of the record. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_type_definition_batch_delete_request( + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def get_headers( + self, + *, + include_term_template: Optional[bool] = None, + type: Optional[Union[str, _models.TypeCategory]] = None, + **kwargs: Any + ) -> List[_models.AtlasTypeDefHeader]: + # pylint: disable=line-too-long + """List all type definitions returned as a list of minimal information header. + + :keyword include_term_template: Whether include termtemplatedef when return all typedefs. + This is always true + when search filter type=term_template. Default value is None. + :paramtype include_term_template: bool + :keyword type: Typedef name as search filter when get typedefs. Known values are: "PRIMITIVE", + "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", + and "TERM_TEMPLATE". Default value is None. + :paramtype type: str or ~azure.purview.datamap.models.TypeCategory + :return: list of AtlasTypeDefHeader + :rtype: list[~azure.purview.datamap.models.AtlasTypeDefHeader] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == [ + { + "category": "str", # Optional. The enum of type category. Known + values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", + "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", and + "TERM_TEMPLATE". + "guid": "str", # Optional. The GUID of the type definition. + "name": "str" # Optional. The name of the type definition. + } + ] + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AtlasTypeDefHeader]] = kwargs.pop("cls", None) + + _request = build_type_definition_get_headers_request( + include_term_template=include_term_template, + type=type, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(List[_models.AtlasTypeDefHeader], response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_term_template_by_id(self, guid: str, **kwargs: Any) -> _models.TermTemplateDef: + # pylint: disable=line-too-long + """Get the term template definition for the given GUID. + + :param guid: The globally unique identifier of the term template. Required. + :type guid: str + :return: TermTemplateDef. The TermTemplateDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.TermTemplateDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TermTemplateDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_term_template_by_id_request( + guid=guid, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TermTemplateDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_term_template_by_name(self, name: str, **kwargs: Any) -> _models.TermTemplateDef: + # pylint: disable=line-too-long + """Get the term template definition by its name (unique). + + :param name: The unique name of the term template. Required. + :type name: str + :return: TermTemplateDef. The TermTemplateDef is compatible with MutableMapping + :rtype: ~azure.purview.datamap.models.TermTemplateDef + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "attributeDefs": [ + { + "cardinality": "str", # Optional. single-valued attribute or + multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "constraints": [ + { + "params": { + "str": {} # Optional. The parameters + of the constraint definition. + }, + "type": "str" # Optional. The type of the + constraint. + } + ], + "defaultValue": "str", # Optional. The default value of the + attribute. + "description": "str", # Optional. The description of the + attribute. + "includeInNotification": bool, # Optional. Determines if it + is included in notification. + "isIndexable": bool, # Optional. Determines if it is + indexable. + "isOptional": bool, # Optional. Determines if it is + optional. + "isUnique": bool, # Optional. Determines if it unique. + "name": "str", # Optional. The name of the attribute. + "options": { + "str": "str" # Optional. The options for the + attribute. + }, + "typeName": "str", # Optional. The name of the type. + "valuesMaxCount": 0, # Optional. The maximum count of the + values. + "valuesMinCount": 0 # Optional. The minimum count of the + values. + } + ], + "category": "str", # Optional. The enum of type category. Known values are: + "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", + "ARRAY", "MAP", "RELATIONSHIP", and "TERM_TEMPLATE". + "createTime": 0, # Optional. The created time of the record. + "createdBy": "str", # Optional. The user who created the record. + "dateFormatter": { + "availableLocales": [ + "str" # Optional. An array of available locales. + ], + "calendar": 0.0, # Optional. Calendar. + "dateInstance": ..., + "dateTimeInstance": ..., + "instance": ..., + "lenient": bool, # Optional. Determines the leniency of the date + format. + "numberFormat": { + "availableLocales": [ + "str" # Optional. The number format. + ], + "currency": "str", # Optional. The currency. + "currencyInstance": ..., + "groupingUsed": bool, # Optional. Determines if grouping is + used. + "instance": ..., + "integerInstance": ..., + "maximumFractionDigits": 0, # Optional. The maximum of + fraction digits. + "maximumIntegerDigits": 0, # Optional. The maximum of + integer digits. + "minimumFractionDigits": 0, # Optional. The minimum of + fraction digits. + "minimumIntegerDigits": 0, # Optional. The minimum of + integer digits. + "numberInstance": ..., + "parseIntegerOnly": bool, # Optional. Determines if only + integer is parsed. + "percentInstance": ..., + "roundingMode": "str" # Optional. The enum of rounding mode. + Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", + "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + }, + "timeInstance": ..., + "timeZone": { + "availableIds": [ + "str" # Optional. An array of available IDs. + ], + "default": ..., + "displayName": "str", # Optional. The display name of the + timezone. + "dstSavings": 0, # Optional. The value of the daylight + saving time. + "id": "str", # Optional. The ID of the timezone. + "rawOffset": 0 # Optional. The raw offset of the timezone. + } + }, + "description": "str", # Optional. The description of the type definition. + "guid": "str", # Optional. The GUID of the type definition. + "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "name": "str", # Optional. The name of the type definition. + "options": { + "str": "str" # Optional. The options for the type definition. + }, + "serviceType": "str", # Optional. The service type. + "typeVersion": "str", # Optional. The version of the type. + "updateTime": 0, # Optional. The update time of the record. + "updatedBy": "str", # Optional. The user who updated the record. + "version": 0 # Optional. The version of the record. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TermTemplateDef] = kwargs.pop("cls", None) + + _request = build_type_definition_get_term_template_by_name_request( + name=name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.AtlasErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TermTemplateDef, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/operations/_patch.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/py.typed b/sdk/purview/azure-purview-datamap/azure/purview/datamap/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/purview/azure-purview-datamap/dev_requirements.txt b/sdk/purview/azure-purview-datamap/dev_requirements.txt new file mode 100644 index 000000000000..c4e89ba26d71 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/dev_requirements.txt @@ -0,0 +1,5 @@ +-e ../../../tools/azure-devtools +-e ../../../tools/azure-sdk-tools +../../core/azure-core +../../identity/azure-identity +aiohttp \ No newline at end of file diff --git a/sdk/purview/azure-purview-datamap/sdk_packaging.toml b/sdk/purview/azure-purview-datamap/sdk_packaging.toml new file mode 100644 index 000000000000..e7687fdae93b --- /dev/null +++ b/sdk/purview/azure-purview-datamap/sdk_packaging.toml @@ -0,0 +1,2 @@ +[packaging] +auto_update = false \ No newline at end of file diff --git a/sdk/purview/azure-purview-datamap/setup.py b/sdk/purview/azure-purview-datamap/setup.py new file mode 100644 index 000000000000..2f897189a3b7 --- /dev/null +++ b/sdk/purview/azure-purview-datamap/setup.py @@ -0,0 +1,71 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# coding: utf-8 + +import os +import re +from setuptools import setup, find_packages + + +PACKAGE_NAME = "azure-purview-datamap" +PACKAGE_PPRINT_NAME = "Azure Purview Datamap" + +# a-b-c => a/b/c +package_folder_path = PACKAGE_NAME.replace("-", "/") + +# Version extraction inspired from 'requests' +with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: + version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) + +if not version: + raise RuntimeError("Cannot find version information") + + +setup( + name=PACKAGE_NAME, + version=version, + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), + long_description=open("README.md", "r").read(), + long_description_content_type="text/markdown", + license="MIT License", + author="Microsoft Corporation", + author_email="azpysdkhelp@microsoft.com", + url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", + keywords="azure, azure sdk", + classifiers=[ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "License :: OSI Approved :: MIT License", + ], + zip_safe=False, + packages=find_packages( + exclude=[ + "tests", + # Exclude packages that will be covered by PEP420 or nspkg + "azure", + "azure.purview", + ] + ), + include_package_data=True, + package_data={ + "azure.purview.datamap": ["py.typed"], + }, + install_requires=[ + "isodate<1.0.0,>=0.6.1", + "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", + ], + python_requires=">=3.8", +) diff --git a/sdk/purview/azure-purview-datamap/tsp-location.yaml b/sdk/purview/azure-purview-datamap/tsp-location.yaml new file mode 100644 index 000000000000..158597a95ecb --- /dev/null +++ b/sdk/purview/azure-purview-datamap/tsp-location.yaml @@ -0,0 +1,5 @@ +additionalDirectories: [] +directory: specification/purview/Azure.Analytics.Purview.DataMap +commit: 70a4ccdd2be61ae5bc524250c70270b0f4f2b540 +repo: Azure/azure-rest-api-specs + diff --git a/sdk/purview/ci.yml b/sdk/purview/ci.yml index 7f450e452a84..f85a38c11f98 100644 --- a/sdk/purview/ci.yml +++ b/sdk/purview/ci.yml @@ -42,3 +42,5 @@ extends: safeName: azurepurviewworkflow - name: azure-purview-sharing safeNAme: azurepurviewsharing + - name: azure-purview-datamap + safeName: azurepurviewdatamap diff --git a/sdk/translation/azure-ai-translator-document/CHANGELOG.md b/sdk/translation/azure-ai-translator-document/CHANGELOG.md new file mode 100644 index 000000000000..628743d283a9 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/CHANGELOG.md @@ -0,0 +1,5 @@ +# Release History + +## 1.0.0b1 (1970-01-01) + +- Initial version diff --git a/sdk/translation/azure-ai-translator-document/LICENSE b/sdk/translation/azure-ai-translator-document/LICENSE new file mode 100644 index 000000000000..63447fd8bbbf --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/sdk/translation/azure-ai-translator-document/MANIFEST.in b/sdk/translation/azure-ai-translator-document/MANIFEST.in new file mode 100644 index 000000000000..13ff2700124c --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/MANIFEST.in @@ -0,0 +1,8 @@ +include *.md +include LICENSE +include azure/ai/translator/document/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/ai/__init__.py +include azure/ai/translator/__init__.py \ No newline at end of file diff --git a/sdk/translation/azure-ai-translator-document/README.md b/sdk/translation/azure-ai-translator-document/README.md new file mode 100644 index 000000000000..c933d566425e --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/README.md @@ -0,0 +1,45 @@ + + +# Azure Ai Translator Document client library for Python + + +## Getting started + +### Installating the package + +```bash +python -m pip install azure-ai-translator-document +``` + +#### Prequisites + +- Python 3.8 or later is required to use this package. +- You need an [Azure subscription][azure_sub] to use this package. +- An existing Azure Ai Translator Document instance. + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials +[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential +[pip]: https://pypi.org/project/pip/ +[azure_sub]: https://azure.microsoft.com/free/ + diff --git a/sdk/translation/azure-ai-translator-document/_meta.json b/sdk/translation/azure-ai-translator-document/_meta.json new file mode 100644 index 000000000000..c0fa5a63d1f3 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "70a4ccdd2be61ae5bc524250c70270b0f4f2b540", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/translation/Azure.AI.DocumentTranslation", + "@azure-tools/typespec-python": "0.21.0" +} \ No newline at end of file diff --git a/sdk/translation/azure-ai-translator-document/azure/__init__.py b/sdk/translation/azure-ai-translator-document/azure/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/__init__.py b/sdk/translation/azure-ai-translator-document/azure/ai/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/__init__.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/__init__.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/__init__.py new file mode 100644 index 000000000000..5ef96bc69a3a --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/__init__.py @@ -0,0 +1,26 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import DocumentTranslationClient +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DocumentTranslationClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_client.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_client.py new file mode 100644 index 000000000000..cf6316186583 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_client.py @@ -0,0 +1,104 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, TYPE_CHECKING, Union + +from azure.core import PipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import DocumentTranslationClientConfiguration +from ._operations import DocumentTranslationClientOperationsMixin +from ._serialization import Deserializer, Serializer + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class DocumentTranslationClient( + DocumentTranslationClientOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword + """DocumentTranslationClient. + + :param endpoint: Supported document Translation endpoints (protocol and hostname, for example: + https://{TranslatorResourceName}.cognitiveservices.azure.com/translator). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Is either a + AzureKeyCredential type or a TokenCredential type. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential or + ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-11-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None: + _endpoint = "{Endpoint}" + self._config = DocumentTranslationClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> "DocumentTranslationClient": + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_configuration.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_configuration.py new file mode 100644 index 000000000000..0bfaadc7b490 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_configuration.py @@ -0,0 +1,74 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING, Union + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from ._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class DocumentTranslationClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for DocumentTranslationClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported document Translation endpoints (protocol and hostname, for example: + https://{TranslatorResourceName}.cognitiveservices.azure.com/translator). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Is either a + AzureKeyCredential type or a TokenCredential type. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential or + ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-11-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-11-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cognitiveservices.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "ai-translator-document/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _infer_policy(self, **kwargs): + if isinstance(self.credential, AzureKeyCredential): + return policies.AzureKeyCredentialPolicy(self.credential, "Ocp-Apim-Subscription-Key", **kwargs) + if hasattr(self.credential, "get_token"): + return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + raise TypeError(f"Unsupported credential: {self.credential}") + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = self._infer_policy(**kwargs) diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_model_base.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_model_base.py new file mode 100644 index 000000000000..1ddc071517d6 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_model_base.py @@ -0,0 +1,874 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except + +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import copy +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] # pylint: disable=protected-access + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): # pylint: disable=unsubscriptable-object + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = copy.deepcopy(data) + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: + ... + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: + ... + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + return self._data.popitem() + + def clear(self) -> None: + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: + ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: + ... + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument + # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' + mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") # pylint: disable=no-member + for k, v in mro_class.__annotations__.items() # pylint: disable=no-member + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) + + return super().__new__(cls) # pylint: disable=no-value-for-parameter + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): # pylint: disable=no-member + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: + for v in cls.__dict__.values(): + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access + return v._rest_name # pylint: disable=protected-access + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): # pylint: disable=no-member + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member + if mapped_cls == cls: + return cls(data) + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation or annotation in [int, float]: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + except AttributeError: + pass + + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) + + try: + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + obj: typing.Dict[typing.Any, typing.Any], + ): + if obj is None: + return obj + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + return functools.partial( + _deserialize_dict, + value_deserializer, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore + + def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, + ): + if obj is None: + return obj + return type(obj)( + _deserialize(deserializer, entry, module) + for entry, deserializer in zip(obj, entry_deserializers) + ) + + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + obj, + ): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + return functools.partial(_deserialize_sequence, deserializer) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): + try: + if value is None or isinstance(value, _Null): + return None + if deserializer is None: + return value + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_operations/__init__.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_operations/__init__.py new file mode 100644 index 000000000000..cfe8b7bf36be --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_operations/__init__.py @@ -0,0 +1,19 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import DocumentTranslationClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DocumentTranslationClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_operations/_operations.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_operations/_operations.py new file mode 100644 index 000000000000..ead5d0a00365 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_operations/_operations.py @@ -0,0 +1,277 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import sys +from typing import Any, Callable, Dict, List, Optional, TypeVar, Union, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import _model_base, models as _models +from .._model_base import _deserialize +from .._serialization import Serializer +from .._vendor import DocumentTranslationClientMixinABC, prepare_multipart_form_data + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_document_translation_document_translate_request( # pylint: disable=name-too-long + *, + target_language: str, + source_language: Optional[str] = None, + category: Optional[str] = None, + allow_fallback: Optional[bool] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-11-01-preview")) + accept = _headers.pop("Accept", "application/octet-stream") + + # Construct URL + _url = "/document:translate" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if source_language is not None: + _params["sourceLanguage"] = _SERIALIZER.query("source_language", source_language, "str") + _params["targetLanguage"] = _SERIALIZER.query("target_language", target_language, "str") + if category is not None: + _params["category"] = _SERIALIZER.query("category", category, "str") + if allow_fallback is not None: + _params["allowFallback"] = _SERIALIZER.query("allow_fallback", allow_fallback, "bool") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +class DocumentTranslationClientOperationsMixin(DocumentTranslationClientMixinABC): + @overload + def document_translate( + self, + body: _models.DocumentTranslateContent, + *, + target_language: str, + source_language: Optional[str] = None, + category: Optional[str] = None, + allow_fallback: Optional[bool] = None, + **kwargs: Any + ) -> bytes: + """API to translate a document. + + :param body: Required. + :type body: ~azure.ai.translator.document.models.DocumentTranslateContent + :keyword target_language: Specifies the language of the output document. + The target language must be one of the supported languages included in the translation scope. + For example if you want to translate the document in German language, then use + targetLanguage=de. Required. + :paramtype target_language: str + :keyword source_language: Specifies source language of the input document. + If this parameter isn't specified, automatic language detection is applied to determine the + source language. + For example if the source document is written in English, then use sourceLanguage=en. Default + value is None. + :paramtype source_language: str + :keyword category: A string specifying the category (domain) of the translation. This parameter + is used to get translations + from a customized system built with Custom Translator. Add the Category ID from your + Custom Translator + project details to this parameter to use your deployed customized system. Default value + is: general. Default value is None. + :paramtype category: str + :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system + when a custom system doesn't exist. + Possible values are: true (default) or false. Default value is None. + :paramtype allow_fallback: bool + :return: bytes + :rtype: bytes + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "document": filetype, + "glossary": [filetype] + } + """ + + @overload + def document_translate( + self, + body: JSON, + *, + target_language: str, + source_language: Optional[str] = None, + category: Optional[str] = None, + allow_fallback: Optional[bool] = None, + **kwargs: Any + ) -> bytes: + """API to translate a document. + + :param body: Required. + :type body: JSON + :keyword target_language: Specifies the language of the output document. + The target language must be one of the supported languages included in the translation scope. + For example if you want to translate the document in German language, then use + targetLanguage=de. Required. + :paramtype target_language: str + :keyword source_language: Specifies source language of the input document. + If this parameter isn't specified, automatic language detection is applied to determine the + source language. + For example if the source document is written in English, then use sourceLanguage=en. Default + value is None. + :paramtype source_language: str + :keyword category: A string specifying the category (domain) of the translation. This parameter + is used to get translations + from a customized system built with Custom Translator. Add the Category ID from your + Custom Translator + project details to this parameter to use your deployed customized system. Default value + is: general. Default value is None. + :paramtype category: str + :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system + when a custom system doesn't exist. + Possible values are: true (default) or false. Default value is None. + :paramtype allow_fallback: bool + :return: bytes + :rtype: bytes + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def document_translate( + self, + body: Union[_models.DocumentTranslateContent, JSON], + *, + target_language: str, + source_language: Optional[str] = None, + category: Optional[str] = None, + allow_fallback: Optional[bool] = None, + **kwargs: Any + ) -> bytes: + """API to translate a document. + + :param body: Is either a DocumentTranslateContent type or a JSON type. Required. + :type body: ~azure.ai.translator.document.models.DocumentTranslateContent or JSON + :keyword target_language: Specifies the language of the output document. + The target language must be one of the supported languages included in the translation scope. + For example if you want to translate the document in German language, then use + targetLanguage=de. Required. + :paramtype target_language: str + :keyword source_language: Specifies source language of the input document. + If this parameter isn't specified, automatic language detection is applied to determine the + source language. + For example if the source document is written in English, then use sourceLanguage=en. Default + value is None. + :paramtype source_language: str + :keyword category: A string specifying the category (domain) of the translation. This parameter + is used to get translations + from a customized system built with Custom Translator. Add the Category ID from your + Custom Translator + project details to this parameter to use your deployed customized system. Default value + is: general. Default value is None. + :paramtype category: str + :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system + when a custom system doesn't exist. + Possible values are: true (default) or false. Default value is None. + :paramtype allow_fallback: bool + :return: bytes + :rtype: bytes + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "document": filetype, + "glossary": [filetype] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[bytes] = kwargs.pop("cls", None) + + _body = body.as_dict() if isinstance(body, _model_base.Model) else body + _file_fields: List[str] = ["document", "glossary"] + _data_fields: List[str] = [] + _files, _data = prepare_multipart_form_data(_body, _file_fields, _data_fields) + + _request = build_document_translation_document_translate_request( + target_language=target_language, + source_language=source_language, + category=category, + allow_fallback=allow_fallback, + api_version=self._config.api_version, + files=_files, + data=_data, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", True) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + response.read() + deserialized = response.content + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_operations/_patch.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_patch.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_serialization.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_serialization.py new file mode 100644 index 000000000000..2f781d740827 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_serialization.py @@ -0,0 +1,1998 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the ""Software""), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + TypeVar, + MutableMapping, + Type, + List, + Mapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +ModelType = TypeVar("ModelType", bound="Model") +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + + +try: + from datetime import timezone as _FixedOffset # type: ignore +except ImportError: # Python 2.7 + + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds() / 3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node.""" + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls: Type[ModelType], + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> ModelType: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result.update(objects[valuetype]._flatten_subtype(key, objects)) + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + Remove the polymorphic key from the initial data. + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + """ + return key.replace("\\.", ".") + + +class Serializer(object): + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises: SerializationError if serialization fails. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized.update(target_obj.additional_properties) + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises: SerializationError if serialization fails. + :raises: ValueError if data is None + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + elif data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, data.__class__) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param data: Object to be serialized. + :rtype: str + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + else: + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. + :rtype: list, str + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + elif obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises: SerializationError if format invalid + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError: + raise TypeError("Unix time object must be valid Datetime object.") + + +def rest_key_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(List[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key.""" + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + else: + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + else: # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer(object): + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + elif isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None: + return data + try: + attributes = response._attribute_map # type: ignore + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + else: + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param raw_data: Data to be processed. + :param content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param response: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [k for k, v in response._validation.items() if v.get("readonly")] + const = [k for k, v in response._validation.items() if v.get("constant")] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) + + def deserialize_data(self, data, data_type): + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + else: + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :rtype: dict + :raises: TypeError if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :rtype: str, int, float or bool + :raises: TypeError if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + else: + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + elif isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + elif attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + else: + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :rtype: long or int + :raises: ValueError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :rtype: TimeDelta + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :rtype: Date + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :rtype: Datetime + :raises: DeserializationError if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + else: + return date_obj diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_vendor.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_vendor.py new file mode 100644 index 000000000000..8e6089bb2dac --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_vendor.py @@ -0,0 +1,69 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +import json +from typing import Any, Dict, IO, List, Mapping, Optional, Sequence, TYPE_CHECKING, Tuple, Union + +from ._configuration import DocumentTranslationClientConfiguration +from ._model_base import Model, SdkJSONEncoder + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import PipelineClient + + from ._serialization import Deserializer, Serializer + + +class DocumentTranslationClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "PipelineClient" + _config: DocumentTranslationClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" + + +# file-like tuple could be `(filename, IO (or bytes))` or `(filename, IO (or bytes), content_type)` +FileContent = Union[str, bytes, IO[str], IO[bytes]] + +FileType = Union[ + # file (or bytes) + FileContent, + # (filename, file (or bytes)) + Tuple[Optional[str], FileContent], + # (filename, file (or bytes), content_type) + Tuple[Optional[str], FileContent, Optional[str]], +] + +FilesType = Union[Mapping[str, FileType], Sequence[Tuple[str, FileType]]] + + +def serialize_multipart_data_entry(data_entry: Any) -> Any: + if isinstance(data_entry, (list, tuple, dict, Model)): + return json.dumps(data_entry, cls=SdkJSONEncoder, exclude_readonly=True) + return data_entry + + +def prepare_multipart_form_data( + body: Mapping[str, Any], multipart_fields: List[str], data_fields: List[str] +) -> Tuple[List[FileType], Dict[str, Any]]: + files: List[FileType] = [] + data: Dict[str, Any] = {} + for multipart_field in multipart_fields: + multipart_entry = body.get(multipart_field) + if isinstance(multipart_entry, list): + files.extend([(multipart_field, e) for e in multipart_entry]) + elif multipart_entry: + files.append((multipart_field, multipart_entry)) + + for data_field in data_fields: + data_entry = body.get(data_field) + if data_entry: + data[data_field] = serialize_multipart_data_entry(data_entry) + + return files, data diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_version.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_version.py new file mode 100644 index 000000000000..be71c81bd282 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/__init__.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/__init__.py new file mode 100644 index 000000000000..2e474443269f --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/__init__.py @@ -0,0 +1,23 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import DocumentTranslationClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DocumentTranslationClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_client.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_client.py new file mode 100644 index 000000000000..bb6c035ef34d --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_client.py @@ -0,0 +1,108 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable, TYPE_CHECKING, Union + +from azure.core import AsyncPipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._serialization import Deserializer, Serializer +from ._configuration import DocumentTranslationClientConfiguration +from ._operations import DocumentTranslationClientOperationsMixin + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class DocumentTranslationClient( + DocumentTranslationClientOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword + """DocumentTranslationClient. + + :param endpoint: Supported document Translation endpoints (protocol and hostname, for example: + https://{TranslatorResourceName}.cognitiveservices.azure.com/translator). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Is either a + AzureKeyCredential type or a TokenCredential type. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential or + ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-11-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__( + self, endpoint: str, credential: Union[AzureKeyCredential, "AsyncTokenCredential"], **kwargs: Any + ) -> None: + _endpoint = "{Endpoint}" + self._config = DocumentTranslationClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> "DocumentTranslationClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_configuration.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_configuration.py new file mode 100644 index 000000000000..59680baec578 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_configuration.py @@ -0,0 +1,76 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING, Union + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from .._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class DocumentTranslationClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for DocumentTranslationClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported document Translation endpoints (protocol and hostname, for example: + https://{TranslatorResourceName}.cognitiveservices.azure.com/translator). Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Is either a + AzureKeyCredential type or a TokenCredential type. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential or + ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-11-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__( + self, endpoint: str, credential: Union[AzureKeyCredential, "AsyncTokenCredential"], **kwargs: Any + ) -> None: + api_version: str = kwargs.pop("api_version", "2023-11-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cognitiveservices.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "ai-translator-document/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _infer_policy(self, **kwargs): + if isinstance(self.credential, AzureKeyCredential): + return policies.AzureKeyCredentialPolicy(self.credential, "Ocp-Apim-Subscription-Key", **kwargs) + if hasattr(self.credential, "get_token"): + return policies.AsyncBearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + raise TypeError(f"Unsupported credential: {self.credential}") + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = self._infer_policy(**kwargs) diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_operations/__init__.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_operations/__init__.py new file mode 100644 index 000000000000..cfe8b7bf36be --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_operations/__init__.py @@ -0,0 +1,19 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import DocumentTranslationClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DocumentTranslationClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_operations/_operations.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_operations/_operations.py new file mode 100644 index 000000000000..99e5166fa360 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_operations/_operations.py @@ -0,0 +1,241 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import sys +from typing import Any, Callable, Dict, List, Optional, TypeVar, Union, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator_async import distributed_trace_async + +from ... import _model_base, models as _models +from ..._model_base import _deserialize +from ..._operations._operations import build_document_translation_document_translate_request +from ..._vendor import prepare_multipart_form_data +from .._vendor import DocumentTranslationClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class DocumentTranslationClientOperationsMixin(DocumentTranslationClientMixinABC): + @overload + async def document_translate( + self, + body: _models.DocumentTranslateContent, + *, + target_language: str, + source_language: Optional[str] = None, + category: Optional[str] = None, + allow_fallback: Optional[bool] = None, + **kwargs: Any + ) -> bytes: + """API to translate a document. + + :param body: Required. + :type body: ~azure.ai.translator.document.models.DocumentTranslateContent + :keyword target_language: Specifies the language of the output document. + The target language must be one of the supported languages included in the translation scope. + For example if you want to translate the document in German language, then use + targetLanguage=de. Required. + :paramtype target_language: str + :keyword source_language: Specifies source language of the input document. + If this parameter isn't specified, automatic language detection is applied to determine the + source language. + For example if the source document is written in English, then use sourceLanguage=en. Default + value is None. + :paramtype source_language: str + :keyword category: A string specifying the category (domain) of the translation. This parameter + is used to get translations + from a customized system built with Custom Translator. Add the Category ID from your + Custom Translator + project details to this parameter to use your deployed customized system. Default value + is: general. Default value is None. + :paramtype category: str + :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system + when a custom system doesn't exist. + Possible values are: true (default) or false. Default value is None. + :paramtype allow_fallback: bool + :return: bytes + :rtype: bytes + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "document": filetype, + "glossary": [filetype] + } + """ + + @overload + async def document_translate( + self, + body: JSON, + *, + target_language: str, + source_language: Optional[str] = None, + category: Optional[str] = None, + allow_fallback: Optional[bool] = None, + **kwargs: Any + ) -> bytes: + """API to translate a document. + + :param body: Required. + :type body: JSON + :keyword target_language: Specifies the language of the output document. + The target language must be one of the supported languages included in the translation scope. + For example if you want to translate the document in German language, then use + targetLanguage=de. Required. + :paramtype target_language: str + :keyword source_language: Specifies source language of the input document. + If this parameter isn't specified, automatic language detection is applied to determine the + source language. + For example if the source document is written in English, then use sourceLanguage=en. Default + value is None. + :paramtype source_language: str + :keyword category: A string specifying the category (domain) of the translation. This parameter + is used to get translations + from a customized system built with Custom Translator. Add the Category ID from your + Custom Translator + project details to this parameter to use your deployed customized system. Default value + is: general. Default value is None. + :paramtype category: str + :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system + when a custom system doesn't exist. + Possible values are: true (default) or false. Default value is None. + :paramtype allow_fallback: bool + :return: bytes + :rtype: bytes + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def document_translate( + self, + body: Union[_models.DocumentTranslateContent, JSON], + *, + target_language: str, + source_language: Optional[str] = None, + category: Optional[str] = None, + allow_fallback: Optional[bool] = None, + **kwargs: Any + ) -> bytes: + """API to translate a document. + + :param body: Is either a DocumentTranslateContent type or a JSON type. Required. + :type body: ~azure.ai.translator.document.models.DocumentTranslateContent or JSON + :keyword target_language: Specifies the language of the output document. + The target language must be one of the supported languages included in the translation scope. + For example if you want to translate the document in German language, then use + targetLanguage=de. Required. + :paramtype target_language: str + :keyword source_language: Specifies source language of the input document. + If this parameter isn't specified, automatic language detection is applied to determine the + source language. + For example if the source document is written in English, then use sourceLanguage=en. Default + value is None. + :paramtype source_language: str + :keyword category: A string specifying the category (domain) of the translation. This parameter + is used to get translations + from a customized system built with Custom Translator. Add the Category ID from your + Custom Translator + project details to this parameter to use your deployed customized system. Default value + is: general. Default value is None. + :paramtype category: str + :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system + when a custom system doesn't exist. + Possible values are: true (default) or false. Default value is None. + :paramtype allow_fallback: bool + :return: bytes + :rtype: bytes + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "document": filetype, + "glossary": [filetype] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[bytes] = kwargs.pop("cls", None) + + _body = body.as_dict() if isinstance(body, _model_base.Model) else body + _file_fields: List[str] = ["document", "glossary"] + _data_fields: List[str] = [] + _files, _data = prepare_multipart_form_data(_body, _file_fields, _data_fields) + + _request = build_document_translation_document_translate_request( + target_language=target_language, + source_language=source_language, + category=category, + allow_fallback=allow_fallback, + api_version=self._config.api_version, + files=_files, + data=_data, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", True) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + await response.read() + deserialized = response.content + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_operations/_patch.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_patch.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_vendor.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_vendor.py new file mode 100644 index 000000000000..64d2ce9faed6 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/aio/_vendor.py @@ -0,0 +1,69 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +import json +from typing import Any, Dict, IO, List, Mapping, Optional, Sequence, TYPE_CHECKING, Tuple, Union + +from ._configuration import DocumentTranslationClientConfiguration +from ._model_base import Model, SdkJSONEncoder + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import AsyncPipelineClient + + from .._serialization import Deserializer, Serializer + + +class DocumentTranslationClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "AsyncPipelineClient" + _config: DocumentTranslationClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" + + +# file-like tuple could be `(filename, IO (or bytes))` or `(filename, IO (or bytes), content_type)` +FileContent = Union[str, bytes, IO[str], IO[bytes]] + +FileType = Union[ + # file (or bytes) + FileContent, + # (filename, file (or bytes)) + Tuple[Optional[str], FileContent], + # (filename, file (or bytes), content_type) + Tuple[Optional[str], FileContent, Optional[str]], +] + +FilesType = Union[Mapping[str, FileType], Sequence[Tuple[str, FileType]]] + + +def serialize_multipart_data_entry(data_entry: Any) -> Any: + if isinstance(data_entry, (list, tuple, dict, Model)): + return json.dumps(data_entry, cls=SdkJSONEncoder, exclude_readonly=True) + return data_entry + + +def prepare_multipart_form_data( + body: Mapping[str, Any], multipart_fields: List[str], data_fields: List[str] +) -> Tuple[List[FileType], Dict[str, Any]]: + files: List[FileType] = [] + data: Dict[str, Any] = {} + for multipart_field in multipart_fields: + multipart_entry = body.get(multipart_field) + if isinstance(multipart_entry, list): + files.extend([(multipart_field, e) for e in multipart_entry]) + elif multipart_entry: + files.append((multipart_field, multipart_entry)) + + for data_field in data_fields: + data_entry = body.get(data_field) + if data_entry: + data[data_field] = serialize_multipart_data_entry(data_entry) + + return files, data diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/models/__init__.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/models/__init__.py new file mode 100644 index 000000000000..8bd914e84a31 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/models/__init__.py @@ -0,0 +1,18 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import DocumentTranslateContent +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DocumentTranslateContent", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/models/_models.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/models/_models.py new file mode 100644 index 000000000000..d7379455fc50 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/models/_models.py @@ -0,0 +1,50 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, List, Mapping, Optional, overload + +from .. import _model_base +from .._model_base import rest_field +from .._vendor import FileType + + +class DocumentTranslateContent(_model_base.Model): + """Document Translate Request / Content. + + All required parameters must be populated in order to send to server. + + :ivar document: Document to be translated in the form. Required. + :vartype document: bytes + :ivar glossary: Glossary / translation memory will be used during translation in the form. + :vartype glossary: list[bytes] + """ + + document: FileType = rest_field(is_multipart_file_input=True) + """Document to be translated in the form. Required.""" + glossary: Optional[List[FileType]] = rest_field(is_multipart_file_input=True) + """Glossary / translation memory will be used during translation in the form.""" + + @overload + def __init__( + self, + *, + document: FileType, + glossary: Optional[List[FileType]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/models/_patch.py b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/models/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/models/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/py.typed b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/azure/ai/translator/document/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/translation/azure-ai-translator-document/dev_requirements.txt b/sdk/translation/azure-ai-translator-document/dev_requirements.txt new file mode 100644 index 000000000000..ff12ab35dd01 --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/dev_requirements.txt @@ -0,0 +1,4 @@ +-e ../../../tools/azure-devtools +-e ../../../tools/azure-sdk-tools +../../core/azure-core +aiohttp \ No newline at end of file diff --git a/sdk/translation/azure-ai-translator-document/sdk_packaging.toml b/sdk/translation/azure-ai-translator-document/sdk_packaging.toml new file mode 100644 index 000000000000..e7687fdae93b --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/sdk_packaging.toml @@ -0,0 +1,2 @@ +[packaging] +auto_update = false \ No newline at end of file diff --git a/sdk/translation/azure-ai-translator-document/setup.py b/sdk/translation/azure-ai-translator-document/setup.py new file mode 100644 index 000000000000..a96cea74890c --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/setup.py @@ -0,0 +1,72 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# coding: utf-8 + +import os +import re +from setuptools import setup, find_packages + + +PACKAGE_NAME = "azure-ai-translator-document" +PACKAGE_PPRINT_NAME = "Azure Ai Translator Document" + +# a-b-c => a/b/c +package_folder_path = PACKAGE_NAME.replace("-", "/") + +# Version extraction inspired from 'requests' +with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: + version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) + +if not version: + raise RuntimeError("Cannot find version information") + + +setup( + name=PACKAGE_NAME, + version=version, + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), + long_description=open("README.md", "r").read(), + long_description_content_type="text/markdown", + license="MIT License", + author="Microsoft Corporation", + author_email="azpysdkhelp@microsoft.com", + url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", + keywords="azure, azure sdk", + classifiers=[ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "License :: OSI Approved :: MIT License", + ], + zip_safe=False, + packages=find_packages( + exclude=[ + "tests", + # Exclude packages that will be covered by PEP420 or nspkg + "azure", + "azure.ai", + "azure.ai.translator", + ] + ), + include_package_data=True, + package_data={ + "azure.ai.translator.document": ["py.typed"], + }, + install_requires=[ + "isodate<1.0.0,>=0.6.1", + "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", + ], + python_requires=">=3.8", +) diff --git a/sdk/translation/azure-ai-translator-document/tsp-location.yaml b/sdk/translation/azure-ai-translator-document/tsp-location.yaml new file mode 100644 index 000000000000..855592ab611c --- /dev/null +++ b/sdk/translation/azure-ai-translator-document/tsp-location.yaml @@ -0,0 +1,5 @@ +repo: Azure/azure-rest-api-specs +commit: 70a4ccdd2be61ae5bc524250c70270b0f4f2b540 +additionalDirectories: [] +directory: specification/translation/Azure.AI.DocumentTranslation + diff --git a/sdk/translation/ci.yml b/sdk/translation/ci.yml index bb8ef7a875af..db16cfbfef89 100644 --- a/sdk/translation/ci.yml +++ b/sdk/translation/ci.yml @@ -35,3 +35,5 @@ extends: safeName: azureaitranslationdocument - name: azure-ai-translation-text safeName: azureaitranslationtext + - name: azure-ai-translator-document + safeName: azureaitranslatordocument diff --git a/sdk/vision/azure-ai-vision-imageanalysis/MANIFEST.in b/sdk/vision/azure-ai-vision-imageanalysis/MANIFEST.in index 0239ba4fd05b..19b8f97e43b7 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/MANIFEST.in +++ b/sdk/vision/azure-ai-vision-imageanalysis/MANIFEST.in @@ -1,8 +1,8 @@ include *.md include LICENSE include azure/ai/vision/imageanalysis/py.typed -recursive-include tests *.py *.md sample.jpg -recursive-include samples *.py *.md sample.jpg run_all_samples.cmd run_all_samples.ps1 +recursive-include tests *.py +recursive-include samples *.py *.md include azure/__init__.py include azure/ai/__init__.py include azure/ai/vision/__init__.py \ No newline at end of file diff --git a/sdk/vision/azure-ai-vision-imageanalysis/_meta.json b/sdk/vision/azure-ai-vision-imageanalysis/_meta.json index e63fcb6c8802..2ab563bdaa34 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/_meta.json +++ b/sdk/vision/azure-ai-vision-imageanalysis/_meta.json @@ -1,6 +1,6 @@ { - "commit": "bef35d01d2572ba131d7f2d4cd8d6313ec649525", + "commit": "70a4ccdd2be61ae5bc524250c70270b0f4f2b540", "repository_url": "https://github.com/Azure/azure-rest-api-specs", - "typespec_src": "specification/cognitiveservices/Vision.ImageAnalysis", - "@azure-tools/typespec-python": "0.15.0" + "typespec_src": "specification/ai/ImageAnalysis", + "@azure-tools/typespec-python": "0.21.0" } \ No newline at end of file diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/__init__.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/__init__.py index f7462abd47f7..b08513e7f1ab 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/__init__.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/__init__.py @@ -6,17 +6,21 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._patch import ImageAnalysisClient +from ._client import ImageAnalysisClient from ._version import VERSION __version__ = VERSION - +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] from ._patch import patch_sdk as _patch_sdk __all__ = [ "ImageAnalysisClient", ] - +__all__.extend([p for p in _patch_all if p not in __all__]) _patch_sdk() diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_model_base.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_model_base.py index bd51cdeb4465..1ddc071517d6 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_model_base.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_model_base.py @@ -5,7 +5,6 @@ # license information. # -------------------------------------------------------------------------- # pylint: disable=protected-access, arguments-differ, signature-differs, broad-except -# pyright: reportGeneralTypeIssues=false import calendar import decimal @@ -16,9 +15,11 @@ import re import copy import typing +import enum import email.utils from datetime import datetime, date, time, timedelta, timezone from json import JSONEncoder +from typing_extensions import Self import isodate from azure.core.exceptions import DeserializationError from azure.core import CaseInsensitiveEnumMeta @@ -35,6 +36,7 @@ __all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") def _timedelta_as_isostr(td: timedelta) -> str: @@ -242,7 +244,7 @@ def _deserialize_date(attr: typing.Union[str, date]) -> date: # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. if isinstance(attr, date): return attr - return isodate.parse_date(attr, defaultmonth=None, defaultday=None) + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore def _deserialize_time(attr: typing.Union[str, time]) -> time: @@ -375,8 +377,12 @@ def get(self, key: str, default: typing.Any = None) -> typing.Any: except KeyError: return default - @typing.overload # type: ignore - def pop(self, key: str) -> typing.Any: # pylint: disable=no-member + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... @typing.overload @@ -397,8 +403,8 @@ def clear(self) -> None: def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: self._data.update(*args, **kwargs) - @typing.overload # type: ignore - def setdefault(self, key: str) -> typing.Any: + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... @typing.overload @@ -438,6 +444,8 @@ def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-m return _serialize_bytes(o, format) if isinstance(o, decimal.Decimal): return float(o) + if isinstance(o, enum.Enum): + return o.value try: # First try datetime.datetime return _serialize_datetime(o, format) @@ -504,7 +512,7 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: def copy(self) -> "Model": return Model(self.__dict__) - def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> "Model": # pylint: disable=unused-argument + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property @@ -546,7 +554,7 @@ def _deserialize(cls, data, exist_discriminators): return cls(data) discriminator = cls._get_discriminator(exist_discriminators) exist_discriminators.append(discriminator) - mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pylint: disable=no-member + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member if mapped_cls == cls: return cls(data) return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access @@ -563,7 +571,7 @@ def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing. if exclude_readonly: readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] for k, v in self.items(): - if exclude_readonly and k in readonly_props: # pyright: ignore[reportUnboundVariable] + if exclude_readonly and k in readonly_props: # pyright: ignore continue is_multipart_file_input = False try: @@ -618,22 +626,22 @@ def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj return obj return _deserialize(model_deserializer, obj) - return functools.partial(_deserialize_model, annotation) + return functools.partial(_deserialize_model, annotation) # pyright: ignore except Exception: pass # is it a literal? try: - if annotation.__origin__ is typing.Literal: + if annotation.__origin__ is typing.Literal: # pyright: ignore return None except AttributeError: pass # is it optional? try: - if any(a for a in annotation.__args__ if a == type(None)): + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore if_obj_deserializer = _get_deserialize_callable_from_annotation( - next(a for a in annotation.__args__ if a != type(None)), module, rf + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore ) def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): @@ -646,7 +654,13 @@ def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Calla pass if getattr(annotation, "__origin__", None) is typing.Union: - deserializers = [_get_deserialize_callable_from_annotation(arg, module, rf) for arg in annotation.__args__] + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] def _deserialize_with_union(deserializers, obj): for deserializer in deserializers: @@ -659,8 +673,10 @@ def _deserialize_with_union(deserializers, obj): return functools.partial(_deserialize_with_union, deserializers) try: - if annotation._name == "Dict": - value_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[1], module, rf) + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) def _deserialize_dict( value_deserializer: typing.Optional[typing.Callable], @@ -677,8 +693,8 @@ def _deserialize_dict( except (AttributeError, IndexError): pass try: - if annotation._name in ["List", "Set", "Tuple", "Sequence"]: - if len(annotation.__args__) > 1: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore def _deserialize_multiple_sequence( entry_deserializers: typing.List[typing.Optional[typing.Callable]], @@ -692,10 +708,13 @@ def _deserialize_multiple_sequence( ) entry_deserializers = [ - _get_deserialize_callable_from_annotation(dt, module, rf) for dt in annotation.__args__ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore ] return functools.partial(_deserialize_multiple_sequence, entry_deserializers) - deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) def _deserialize_sequence( deserializer: typing.Optional[typing.Callable], @@ -787,6 +806,10 @@ def __init__( self._format = format self._is_multipart_file_input = is_multipart_file_input + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + @property def _rest_name(self) -> str: if self._rest_name_input is None: diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_patch.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_patch.py index 4a4ed79b677c..1801f044097b 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_patch.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_patch.py @@ -87,7 +87,6 @@ def analyze_from_url( **kwargs ) - @distributed_trace def analyze( self, diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_serialization.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_serialization.py index baa661cb82d2..2f781d740827 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_serialization.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_serialization.py @@ -170,13 +170,6 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], return None -try: - basestring # type: ignore - unicode_str = unicode # type: ignore -except NameError: - basestring = str - unicode_str = str - _LOGGER = logging.getLogger(__name__) try: @@ -545,7 +538,7 @@ class Serializer(object): "multiple": lambda x, y: x % y != 0, } - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.serialize_type = { "iso-8601": Serializer.serialize_iso, "rfc-1123": Serializer.serialize_rfc, @@ -561,7 +554,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "[]": self.serialize_iter, "{}": self.serialize_dict, } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: Dict[str, type] = dict(classes) if classes else {} self.key_transformer = full_restapi_key_transformer self.client_side_validation = True @@ -649,7 +642,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): else: # That's a basic type # Integrate namespace if necessary local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) - local_node.text = unicode_str(new_attr) + local_node.text = str(new_attr) serialized.append(local_node) # type: ignore else: # JSON for k in reversed(keys): # type: ignore @@ -994,7 +987,7 @@ def serialize_object(self, attr, **kwargs): return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) if obj_type is _long_type: return self.serialize_long(attr) - if obj_type is unicode_str: + if obj_type is str: return self.serialize_unicode(attr) if obj_type is datetime.datetime: return self.serialize_iso(attr) @@ -1370,7 +1363,7 @@ class Deserializer(object): valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.deserialize_type = { "iso-8601": Deserializer.deserialize_iso, "rfc-1123": Deserializer.deserialize_rfc, @@ -1390,7 +1383,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "duration": (isodate.Duration, datetime.timedelta), "iso-8601": (datetime.datetime), } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: Dict[str, type] = dict(classes) if classes else {} self.key_extractors = [rest_key_extractor, xml_key_extractor] # Additional properties only works if the "rest_key_extractor" is used to # extract the keys. Making it to work whatever the key extractor is too much @@ -1443,7 +1436,7 @@ def _deserialize(self, target_obj, data): response, class_name = self._classify_target(target_obj, data) - if isinstance(response, basestring): + if isinstance(response, str): return self.deserialize_data(data, response) elif isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) @@ -1514,14 +1507,14 @@ def _classify_target(self, target, data): if target is None: return None, None - if isinstance(target, basestring): + if isinstance(target, str): try: target = self.dependencies[target] except KeyError: return target, target try: - target = target._classify(data, self.dependencies) + target = target._classify(data, self.dependencies) # type: ignore except AttributeError: pass # Target is not a Model, no classify return target, target.__class__.__name__ # type: ignore @@ -1577,7 +1570,7 @@ def _unpack_content(raw_data, content_type=None): if hasattr(raw_data, "_content_consumed"): return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) - if isinstance(raw_data, (basestring, bytes)) or hasattr(raw_data, "read"): + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore return raw_data @@ -1699,7 +1692,7 @@ def deserialize_object(self, attr, **kwargs): if isinstance(attr, ET.Element): # Do no recurse on XML, just return the tree as-is return attr - if isinstance(attr, basestring): + if isinstance(attr, str): return self.deserialize_basic(attr, "str") obj_type = type(attr) if obj_type in self.basic_types: @@ -1756,7 +1749,7 @@ def deserialize_basic(self, attr, data_type): if data_type == "bool": if attr in [True, False, 1, 0]: return bool(attr) - elif isinstance(attr, basestring): + elif isinstance(attr, str): if attr.lower() in ["true", "1"]: return True elif attr.lower() in ["false", "0"]: diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_version.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_version.py index c43fdbc2e239..be71c81bd282 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_version.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_version.py @@ -6,4 +6,4 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -VERSION = "1.0.0b3" +VERSION = "1.0.0b1" diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/__init__.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/__init__.py index 4e185770e8d5..4fed93494fc6 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/__init__.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/__init__.py @@ -6,14 +6,18 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._patch import ImageAnalysisClient - +from ._client import ImageAnalysisClient +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] from ._patch import patch_sdk as _patch_sdk __all__ = [ "ImageAnalysisClient", ] - +__all__.extend([p for p in _patch_all if p not in __all__]) _patch_sdk() diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/_patch.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/_patch.py index 117a0e6c4ebb..68bfdb00fb21 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/_patch.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/_patch.py @@ -87,7 +87,6 @@ async def analyze_from_url( **kwargs ) - @distributed_trace_async async def analyze( self, diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_caption_image_file_async.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_caption_image_file_async.py index 35b3b001da4a..5f857c22d792 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_caption_image_file_async.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_caption_image_file_async.py @@ -48,16 +48,10 @@ async def sample_caption_image_file_async(): image_data = f.read() # Create an asynchronous Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Get a caption for the image, asynchronously. - result = await client.analyze( - image_data=image_data, - visual_features=[VisualFeatures.CAPTION] - ) + result = await client.analyze(image_data=image_data, visual_features=[VisualFeatures.CAPTION]) await client.close() diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_ocr_image_url_async.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_ocr_image_url_async.py index 502d05d4417d..2a3e1af4cfcf 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_ocr_image_url_async.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_ocr_image_url_async.py @@ -47,15 +47,11 @@ async def sample_ocr_image_file_async(): exit() # Create an asynchronous Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Extract text (OCR) from an image URL, asynchronously. result = await client.analyze_from_url( - image_url="https://aka.ms/azsdk/image-analysis/sample.jpg", - visual_features=[VisualFeatures.READ] + image_url="https://aka.ms/azsdk/image-analysis/sample.jpg", visual_features=[VisualFeatures.READ] ) await client.close() @@ -67,7 +63,9 @@ async def sample_ocr_image_file_async(): for line in result.read.blocks[0].lines: print(f" Line: '{line.text}', Bounding box {line.bounding_polygon}") for word in line.words: - print(f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}") + print( + f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}" + ) print(f" Image height: {result.metadata.height}") print(f" Image width: {result.metadata.width}") print(f" Model version: {result.model_version}") diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_analyze_all_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_analyze_all_image_file.py index 08ce7f3d584c..6a04a2faf266 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_analyze_all_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_analyze_all_image_file.py @@ -70,11 +70,7 @@ def sample_analyze_all_image_file(): # [START create_client_with_logging] # Create an Image Analysis client with none redacted log - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key), - logging_enable=True - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key), logging_enable=True) # [END create_client_with_logging] # Analyze all visual features from an image stream. This will be a synchronously (blocking) call. @@ -112,7 +108,9 @@ def sample_analyze_all_image_file(): for line in result.read.blocks[0].lines: print(f" Line: '{line.text}', Bounding box {line.bounding_polygon}") for word in line.words: - print(f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}") + print( + f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}" + ) if result.tags is not None: print(" Tags:") diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_file.py index 5570b2b4996f..e060626cc6e9 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_file.py @@ -45,10 +45,7 @@ def sample_caption_image_file(): exit() # Create an Image Analysis client for synchronous operations - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # [END create_client] # [START caption] diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_url.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_url.py index fe9dad3aa4a1..c6d99f21b25e 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_url.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_url.py @@ -44,10 +44,7 @@ def sample_caption_image_url(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # [START caption] # Get a caption for the image. This will be a synchronously (blocking) call. diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_dense_captions_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_dense_captions_image_file.py index 8f268cb76ee0..5e062467ca67 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_dense_captions_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_dense_captions_image_file.py @@ -48,10 +48,7 @@ def sample_dense_captions_image_file(): exit() # Create an Image Analysis client. - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Load image to analyze into a 'bytes' object. with open("sample.jpg", "rb") as f: diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_objects_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_objects_image_file.py index b3aec2ead684..0bf98d2d05a6 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_objects_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_objects_image_file.py @@ -41,20 +41,14 @@ def sample_objects_image_file(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Load image to analyze into a 'bytes' object with open("sample.jpg", "rb") as f: image_data = f.read() # Detect objects in an image stream. This will be a synchronously (blocking) call. - result = client.analyze( - image_data=image_data, - visual_features=[VisualFeatures.OBJECTS] - ) + result = client.analyze(image_data=image_data, visual_features=[VisualFeatures.OBJECTS]) # Print Objects analysis results to the console print("Image analysis results:") diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_file.py index 3715bf4618a6..766e8122ec34 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_file.py @@ -47,10 +47,7 @@ def sample_ocr_image_file(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # [START read] # Load image to analyze into a 'bytes' object @@ -58,10 +55,7 @@ def sample_ocr_image_file(): image_data = f.read() # Extract text (OCR) from an image stream. This will be a synchronously (blocking) call. - result = client.analyze( - image_data=image_data, - visual_features=[VisualFeatures.READ] - ) + result = client.analyze(image_data=image_data, visual_features=[VisualFeatures.READ]) # Print text (OCR) analysis results to the console print("Image analysis results:") @@ -70,7 +64,9 @@ def sample_ocr_image_file(): for line in result.read.blocks[0].lines: print(f" Line: '{line.text}', Bounding box {line.bounding_polygon}") for word in line.words: - print(f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}") + print( + f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}" + ) # [END read] print(f" Image height: {result.metadata.height}") print(f" Image width: {result.metadata.width}") diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_url.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_url.py index 96a835bb9cb3..42118166b116 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_url.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_url.py @@ -47,16 +47,12 @@ def sample_ocr_image_url(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # [START read] # Extract text (OCR) from an image stream. This will be a synchronously (blocking) call. result = client.analyze_from_url( - image_url="https://aka.ms/azsdk/image-analysis/sample.jpg", - visual_features=[VisualFeatures.READ] + image_url="https://aka.ms/azsdk/image-analysis/sample.jpg", visual_features=[VisualFeatures.READ] ) # Print text (OCR) analysis results to the console @@ -66,7 +62,9 @@ def sample_ocr_image_url(): for line in result.read.blocks[0].lines: print(f" Line: '{line.text}', Bounding box {line.bounding_polygon}") for word in line.words: - print(f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}") + print( + f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}" + ) # [END read] print(f" Image height: {result.metadata.height}") print(f" Image width: {result.metadata.width}") diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_people_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_people_image_file.py index c540bcf0c897..c506ea91d19a 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_people_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_people_image_file.py @@ -40,20 +40,14 @@ def sample_people_image_file(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Load image to analyze into a 'bytes' object with open("sample.jpg", "rb") as f: image_data = f.read() # Find people in an image stream. This will be a synchronously (blocking) call. - result = client.analyze( - image_data=image_data, - visual_features=[VisualFeatures.PEOPLE] - ) + result = client.analyze(image_data=image_data, visual_features=[VisualFeatures.PEOPLE]) # Print People analysis results to the console print("Image analysis results:") diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_smart_crops_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_smart_crops_image_file.py index c9d4cdeec8d2..b2aac22a02cb 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_smart_crops_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_smart_crops_image_file.py @@ -49,10 +49,7 @@ def sample_smart_crops_image_file(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Load image to analyze into a 'bytes' object with open("sample.jpg", "rb") as f: diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_tags_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_tags_image_file.py index d2cc94f3f746..b32c783f961e 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_tags_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_tags_image_file.py @@ -42,10 +42,7 @@ def sample_tags_image_file(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Load image to analyze into a 'bytes' object with open("sample.jpg", "rb") as f: diff --git a/sdk/vision/azure-ai-vision-imageanalysis/setup.py b/sdk/vision/azure-ai-vision-imageanalysis/setup.py index b8b29a5bb973..f250e17b33ad 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/setup.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/setup.py @@ -66,6 +66,7 @@ install_requires=[ "isodate<1.0.0,>=0.6.1", "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", ], python_requires=">=3.8", ) diff --git a/sdk/vision/azure-ai-vision-imageanalysis/tsp-location.yaml b/sdk/vision/azure-ai-vision-imageanalysis/tsp-location.yaml index f3498ff59bfe..6291dcfe6ae2 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/tsp-location.yaml +++ b/sdk/vision/azure-ai-vision-imageanalysis/tsp-location.yaml @@ -1,6 +1,5 @@ additionalDirectories: [] +commit: 70a4ccdd2be61ae5bc524250c70270b0f4f2b540 repo: Azure/azure-rest-api-specs directory: specification/ai/ImageAnalysis -commit: 3cf7400ba3d65978bef86e9c4197a5e7f7bf5277 -